Importare un'API GraphQL

SI APPLICA A: Tutti i livelli di Gestione API

In Gestione API, è possibile aggiungere un'API GraphQL in uno dei due modelli: effettuare il pass-through a un endpoint GraphQL esistente o importare uno schema GraphQL e creare un'API GraphQL sintetica con sistemi di risoluzione di campi personalizzati. Per ulteriori informazioni, consultare la panoramica di GraphQL.

Contenuto dell'articolo:

  • Aggiungere un'API GraphQL pass-through all'istanza di Gestione API.
  • Testare l'API GraphQL.

Se si vuole importare uno schema GraphQL e configurare i sistemi di risoluzione dei campi usando endpoint REST o SOAP API, consultare Importare uno schema GraphQL e configurare i sistemi di risoluzione dei campi.

Prerequisiti

Aggiungere un'API GraphQL

  1. Nel portale di Azure accedere all'istanza di Gestione API.

  2. Nel menu a sinistra, selezionare API >+ Aggiungi API.

  3. In Definisci una nuova API, selezionare l'icona GraphQL.

    Screenshot della selezione dell'icona GraphQL nell'elenco API.

  4. Nella finestra di dialogo, selezionare Completo e completare i campi modulo richiesti.

    Screenshot dei campi per la creazione di API GraphQL.

    Campo Descrzione
    Nome visualizzato Il nome con cui verrà visualizzata l'API GraphQL.
    Nome Nome non elaborato dell'API GraphQL. Si popola automaticamente durante la digitazione del nome visualizzato.
    Tipo GraphQL Selezionare pass-through GraphQL per importare da un endpoint dell'API GraphQL esistente.
    Endpoint dell'API GraphQL URL di base con il nome dell'endpoint dell'API GraphQL.
    Ad esempio: https://example.com/your-GraphQL-name. È anche possibile usare un comune endpoint GraphQL “swapi”, come una demo https://swapi-graphql.azure-api.net/graphql.
    Carica schema Selezionare facoltativamente per esplorare e caricare il file di schema per sostituire lo schema recuperato dall'endpoint GraphQL (se disponibile).
    Descrizione Aggiungere una descrizione dell'API.
    Schema URL Effettuare una selezione in base all'endpoint GraphQL. Selezionare una delle opzioni che includono uno schema WebSocket (WS o WSS) se l'API GraphQL include il tipo di sottoscrizione. Selezione predefinita: HTTP(S).
    Suffisso dell'URL dell'API Aggiungere un suffisso URL per identificare l’API specifica in questa istanza di Gestione API. Deve essere univoco nell'istanza di Gestione API.
    URL di base Campo non modificabile che mostra l'URL di base dell'API
    Tag Associare l'API GraphQL a tag nuovi o esistenti.
    Prodotti Associare l'API GraphQL a un prodotto per pubblicarlo.
    Assegnare un numero di versione a questa API? Selezionare questa opzione per applicare uno schema di controllo delle versioni all'API GraphQL.
  5. Seleziona Crea.

  6. Dopo aver creato l'API, esplorare o modificare lo schema nella scheda progettazione. Screenshot dell'esplorazione dello schema GraphQL nel portale.

Testare l'API GraphQL

  1. Passare all'istanza di Gestione API.

  2. Nel menu di spostamento laterale, nella sezione API selezionare API.

  3. In Tutte le API, selezionare l'API GraphQL.

  4. Selezionare la scheda Test per accedere alla console di test.

  5. In Intestazioni:

    1. Selezionare l'intestazione dal menu a discesa Nome.
    2. Immettere il valore nel campo Valore.
    3. Aggiungere altre intestazioni selezionando + Aggiungi intestazione.
    4. Eliminare le intestazioni usando l'icona cestino.
  6. Se è stato aggiunto un prodotto all'API GraphQL, applicare l'ambito del prodotto in Applica ambito prodotto.

  7. Nell'editor query, eseguire una delle seguenti operazioni:

    1. Selezionare almeno un campo o un sottocampo dall'elenco nel menu laterale. I campi e i sottocampi selezionati vengono visualizzati nell'editor query.

    2. Iniziare a digitare nell'editor query per comporre una query.

      Screenshot dell'aggiunta di campi all'editor di query.

  8. In Variabili di query, aggiungere variabili per riutilizzare la stessa query o la stessa mutazione e passare valori diversi.

  9. Selezionare Invia.

  10. Visualizzare la risposta.

    Screenshot della visualizzazione della risposta alla query di test.

  11. Ripetere i passaggi precedenti per testare altri payload.

  12. Al termine del test, uscire dalla console di test.

Testare una sottoscrizione

Se l'API GraphQL supporta una sottoscrizione, è possibile testarla nella console di test.

  1. Assicurarsi che l'API consenta uno schema URL WebSocket (WS o WSS) adatto per l'API. È possibile abilitare questa impostazione nella scheda Impostazioni.

  2. Configurare una query di sottoscrizione nell'editor di query, quindi selezionare Connetti per stabilire una connessione WebSocket con il servizio back-end.

    Screenshot di una query di sottoscrizione nell'editor di query.

  3. Revisionare i dettagli della connessione nel riquadro Sottoscrizione.

    Screenshot della connessione Websocket nel portale.

  4. Gli eventi sottoscritti appaiono nel riquadro Sottoscrizione. La connessione WebSocket viene mantenuta fino alla disconnessione o alla connessione a una nuova sottoscrizione WebSocket.

    Screenshot degli eventi di sottoscrizione graphQL nel portale.

Proteggere l'API GraphQL

Proteggere l’API GraphQL applicando sia i criteri di autenticazione e autorizzazione sia un criterio di convalida di GraphQL per la protezione da attacchi specifici per GraphQL.

Passaggi successivi