Aggiungere un'API GraphQL sintetica e configurare i sistemi di risoluzione di campi

Articolo
03/20/2024

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 su un endpoint GraphQL esistente o importare uno schema GraphQL e creare un'API GraphQL sintetica con sistemi di risoluzione di campi personalizzati. Per altre informazioni, vedere la panoramica di GraphQL.

Contenuto dell'articolo:

Importare uno schema GraphQL nell'istanza di Gestione API
Configurare un sistema di risoluzione per una query GraphQL usando un endpoint HTTP esistente
Testare l'API GraphQL

Per esporre un endpoint GraphQL esistente come API, vedere Importare un'API GraphQL.

Prerequisiti

Un'istanza di Gestione API esistente. Crearne una se non è già stato fatto.
File di schema GraphQL valido con l'estensione .graphql.
Un endpoint GraphQL back-end è facoltativo per questo scenario.

Passare all'istanza di Gestione API

Nel portale di Azure, cercare e selezionare Servizi Gestione API.
Nella pagina Servizi Gestione API selezionare l'istanza di Gestione API.

Aggiungere uno schema GraphQL

Nel menu di spostamento laterale, nella sezione API selezionare API.
In Definisci una nuova API selezionare l'icona GraphQL.

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

Screenshot dei campi per la creazione di un'API GraphQL.

Campo	Descrzione
Nome visualizzato	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 GraphQL sintetico da importare da un file di schema GraphQL.
Eseguire il fallback dell'endpoint GraphQL	Facoltativamente, immettere un URL con un nome endpoint dell'API GraphQL. Gestione API passa query GraphQL a questo endpoint quando un sistema di risoluzione personalizzato non è impostato per un campo.
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.

Seleziona Crea.
Dopo aver creato l'API, esplorare o modificare lo schema nella scheda Progettazione.

Configurare il sistema di risoluzione

Configurare un sistema di risoluzione per eseguire il mapping di un campo dello schema a un endpoint HTTP esistente. I passaggi generali sono disponibili qui. Per informazioni dettagliate, vedere Configurare un sistema di risoluzione GraphQL.

Si supponga di aver importato lo schema GraphQL di base seguente e di voler configurare un sistema di risoluzione per la query utenti.

type Query {
    users: [User]
}

type User {
    id: String!
    name: String!
}

Nel menu di spostamento laterale, nella sezione API selezionare API> per l'API GraphQL.
Nella scheda Schema esaminare lo schema di un campo del tipo di oggetto in cui si vuole configurare un sistema di risoluzione.
1. Selezionare un campo, quindi passare il puntatore del mouse sul margine sinistro.
2. Selezionare + Aggiungi sistema di risoluzione
Nella pagina Crea sistema di risoluzione:
1. Aggiornare la proprietà Nome se si desidera immettere facoltativamente una descrizione e confermare o aggiornare le selezioni Tipo e Campo.
2. In Origine dati selezionare API HTTP.
Nell'editor dei criteri del sistema di risoluzione aggiornare l'elemento <http-data-source> con gli elementi figlio dello scenario. Ad esempio, il sistema di risoluzione seguente recupera il campo utenti effettuando una chiamata GET a un'origine dati HTTP esistente.
```
    <http-data-source>
        <http-request>
            <set-method>GET</set-method>
            <set-url>https://myapi.contoso.com/users</set-url>
        </http-request>
    </http-data-source>
```
Seleziona Crea.
Per risolvere i dati di un altro campo dello schema, ripetere i passaggi precedenti per creare un sistema di risoluzione.

Suggerimento

Quando si modifica un criterio del sistema di risoluzione, selezionare Esegui test per controllare l'output dell'origine dati, che è possibile convalidare in base allo schema. Se si verificano errori, la risposta include informazioni sulla risoluzione dei problemi.

Testare l'API GraphQL

Passare all'istanza di Gestione API.
Nel menu di spostamento laterale, nella sezione API selezionare API.
In Tutte le API selezionare l'API GraphQL.
Selezionare la scheda Test per accedere alla console di test.
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.
Se è stato aggiunto un prodotto all'API GraphQL, applicare l'ambito del prodotto in Applica ambito prodotto.
Nell'editor query eseguire una delle operazioni seguenti:
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.
In Variabili di query aggiungere variabili per riutilizzare la stessa query o la stessa mutazione e passare valori diversi.
Selezionare Invia.
Visualizzare la risposta.
Ripetere i passaggi precedenti per testare payload diversi.
Al termine del test, uscire dalla console di test.

Proteggere l'API GraphQL

Proteggere l'API GraphQL applicando criteri di autenticazione e autorizzazione esistenti e criteri di convalida GraphQL per proteggersi da attacchi specifici di GraphQL.

Passaggi successivi

Trasformare e proteggere un'API pubblicata