Importera ett GraphQL API (förhandsversion)

Artikel
11/23/2021
2 minuter för att läsa

GraphQL är ett frågespråk med öppen källkod som är branschstandard för API:er. Till skillnad från slutpunktsbaserade (eller REST-liknande) API:er som är utformade för åtgärder över resurser stöder GraphQL-API:er en bredare uppsättning användningsfall och fokuserar på datatyper, scheman och frågor.

API Management tar itu med de säkerhets-, autentiserings- och auktoriseringsutmaningar som följer med publicering av GraphQL-API:er. Med API Management för att exponera graphQL-API:er kan du:

Lägg till en GraphQL-tjänst som API:er via Azure Portal.
Skydda GraphQL-API:er genom att tillämpa både befintliga principer för åtkomstkontroll och en ny princip för att skydda mot GraphQL-specifika attacker.
Utforska schemat och kör testfrågor mot GraphQL-API:erna i Azure- och utvecklarportalerna.

Viktigt

API Management GraphQL API är för närvarande i förhandsversion.

I den här artikeln kommer du att:

Läs mer om fördelarna med att använda GraphQL-API:er.
Lägg till ett GraphQL-API till din API Management instans.
Testa GraphQL-API:et.
Lär dig begränsningarna för GraphQL API i API Management.

Förutsättningar

En befintlig API Management instans. Skapa en om du inte redan har gjort det.
Ett GraphQL-API.

Lägga till ett GraphQL API

Gå till din API Management instans.
I navigeringsmenyn på sidan går du till avsnittet API:er och väljer API:er.
Under Definiera ett nytt API väljer du GraphQL-ikonen.

I dialogrutan väljer du Fullständig och fyller i de obligatoriska formulärfälten.

Demonstrera fält för att skapa GraphQL

Fält	Beskrivning
Visningsnamn	Namnet som graphQL-API:et ska visas med.
Name	Rådatanamn för GraphQL-API:et. Fylls i automatiskt när du skriver visningsnamnet.
GraphQL API-slutpunkt	Bas-URL:en med slutpunktsnamnet för GraphQL-API:et. Till exempel: `https://example.com/your-GraphQL-name` . Du kan också använda den vanliga GraphQL-slutpunkten "Star Wars" som en demo.
Upload schemafil	Välj för att bläddra och ladda upp schemafilen.
Beskrivning	Lägg till en beskrivning av ditt API.
URL-schema	Välj HTTP, HTTPS eller Båda. Standardval: Båda.
API URL-suffix	Lägg till ett URL-suffix för att identifiera det här specifika API:et API Management instansen. Det måste vara unikt i den här API Management instansen.
Grundläggande URL	Det går inte att ändra fältet som visar API-bas-URL:en
Taggar	Associera graphQL-API:et med nya eller befintliga taggar.
Produkter	Associera graphQL-API:et med en produkt för att publicera den.
Gateways	Associera graphQL-API:et med befintliga gatewayer. Standardval av gateway: Hanterad.
Vilken är versionen för det här API:et?	Välj versionskontroll för GraphQL-API:et.

Klicka på Skapa.

Testa graphQL-API:et

Gå till din API Management instans.
I navigeringsmenyn på sidan går du till avsnittet API:er och väljer API:er.
Under Alla API:er väljer du ditt GraphQL API.
Välj fliken Test för att få åtkomst till testkonsolen.
Under Rubriker:
1. Välj rubriken i listrutan 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 papperskorgsikonen.
Om du har lagt till en produkt i GraphQL-API:et tillämpar du produktomfånget under Tillämpa produktomfång.
Under Frågeredigeraren gör du något av följande:
1. Välj minst ett fält eller underfält i listan på sidomenyn. De fält och underfält som du väljer visas i frågeredigeraren.
2. Börja skriva i frågeredigeraren för att skapa en fråga.
Under Frågevariabler lägger du till variabler för att återanvända samma fråga eller än och skicka olika värden.
Klicka på Skicka.
Visa svaret.
Upprepa föregående steg för att testa olika nyttolaster.
När testningen är klar avslutar du testkonsolen.

Begränsningar

Endast GraphQL-genomspassning stöds.
Ett enda GraphQL API i API Management motsvarar endast en enda GraphQL-slutpunkt för backend.

Nästa steg

Omvandla och skydda ett publicerat API