Importera ett GraphQL-API

GÄLLER FÖR: Alla API Management-nivåer

I API Management kan du lägga till ett GraphQL-API i någon av två modeller: direkt till en befintlig GraphQL-slutpunkt eller importera ett GraphQL-schema och skapa ett syntetiskt GraphQL-API med anpassade fältlösare. Mer information finns i GraphQL-översikten.

I den här artikeln ska du:

  • Lägg till ett GraphQL-API för direktströmning till din API Management-instans.
  • Testa GraphQL-API:et.

Om du vill importera ett GraphQL-schema och konfigurera fältlösare med hjälp av REST- eller SOAP API-slutpunkter kan du läsa Importera ett GraphQL-schema och konfigurera fältlösare.

Förutsättningar

Lägga till ett GraphQL-API

  1. I Azure-portalen går du till din API Management-instans.

  2. I den vänstra menyn väljer du API:er>+ Lägg till API.

  3. Under Definiera ett nytt API väljer du GraphQL-ikonen .

    Skärmbild av att välja GraphQL-ikonen i listan över API:er.

  4. I dialogrutan väljer du Fullständig och slutför de obligatoriska formulärfälten.

    Skärmbild av fält för att skapa ett GraphQL-API.

    Fält Description
    Visningsnamn Namnet som GraphQL-API:et ska visas med.
    Namn Raw-namnet på GraphQL-API:et. Fylls i automatiskt när du skriver visningsnamnet.
    GraphQL-typ Välj DirektgrafQL för att importera från en befintlig GraphQL API-slutpunkt.
    GraphQL API-slutpunkt Bas-URL:en med ditt GraphQL API-slutpunktsnamn.
    Exempel: https://example.com/your-GraphQL-name. Du kan också använda en vanlig "swapi" GraphQL-slutpunkt, till exempel https://swapi-graphql.azure-api.net/graphql en demo.
    Ladda upp schema Du kan också välja att bläddra och ladda upp schemafilen för att ersätta schemat som hämtats från GraphQL-slutpunkten (om det är tillgängligt).
    Beskrivning Lägg till en beskrivning av ditt API.
    URL-schema Gör ett val baserat på GraphQL-slutpunkten. Välj ett av alternativen som innehåller ett WebSocket-schema (WS eller WSS) om GraphQL-API:et innehåller prenumerationstypen. Standardval: HTTP(S).
    API URL-suffix Lägg till ett URL-suffix för att identifiera det här specifika API:et i den här API Management-instansen. Den måste vara unik i den här API Management-instansen.
    Grundläggande URL Namnlös fält som visar din API-bas-URL
    Taggar Associera GraphQL-API:et med nya eller befintliga taggar.
    Produkter Associera GraphQL-API:et med en produkt för att publicera det.
    Version av det här API:et? Välj om du vill tillämpa ett versionsschema på GraphQL-API:et.
  5. Välj Skapa.

  6. När API:et har skapats bläddrar eller ändrar du schemat på fliken Design . Skärmbild av att utforska GraphQL-schemat i portalen.

Testa GraphQL-API:et

  1. Gå till din API Management-instans.

  2. I sidonavigeringsmenyn går du till avsnittet API:er och väljer API:er.

  3. Under Alla API:er väljer du ditt GraphQL-API.

  4. Välj fliken Test för att komma åt testkonsolen.

  5. Under Rubriker:

    1. Välj rubriken på den nedrullningsbara menyn Namn .
    2. Ange värdet i fältet Värde .
    3. Lägg till fler rubriker genom att välja + Lägg till rubrik.
    4. Ta bort rubriker med hjälp av papperskorgsikonen.
  6. Om du har lagt till en produkt i GraphQL-API:et använder du produktomfånget under Tillämpa produktomfång.

  7. Under Frågeredigeraren:

    1. Välj minst ett fält eller underfält i listan på sidomenyn. Fälten och underfälten som du väljer visas i frågeredigeraren.

    2. Börja skriva i frågeredigeraren för att skriva en fråga.

      Skärmbild av att lägga till fält i frågeredigeraren.

  8. Under Frågevariabler lägger du till variabler för att återanvända samma fråga eller mutation och skicka olika värden.

  9. Välj Skicka.

  10. Visa svaret.

    Skärmbild av att visa testfrågesvaret.

  11. Upprepa föregående steg för att testa olika nyttolaster.

  12. När testningen är klar avslutar du testkonsolen.

Testa en prenumeration

Om graphQL-API:et stöder en prenumeration kan du testa den i testkonsolen.

  1. Se till att ditt API tillåter ett WebSocket URL-schema (WS eller WSS) som är lämpligt för ditt API. Du kan aktivera den här inställningen på fliken Inställningar .

  2. Konfigurera en prenumerationsfråga i frågeredigeraren och välj sedan Anslut för att upprätta en WebSocket-anslutning till serverdelstjänsten.

    Skärmbild av en prenumerationsfråga i frågeredigeraren.

  3. Granska anslutningsinformationen i fönstret Prenumeration .

    Skärmbild av Websocket-anslutning i portalen.

  4. Händelser som prenumererar visas i fönstret Prenumeration . WebSocket-anslutningen underhålls tills du kopplar från den eller ansluter till en ny WebSocket-prenumeration.

    Skärmbild av GraphQL-prenumerationshändelser i portalen.

Skydda GraphQL-API:et

Skydda GraphQL-API:et genom att använda både befintliga autentiserings- och auktoriseringsprinciper och en GraphQL-valideringsprincip för att skydda mot GraphQL-specifika attacker.

Nästa steg