Een GraphQL-API importeren (preview)

GraphQL is een open-source, industriestandaard querytaal voor API's. In tegenstelling tot api's op basis van eindpunten (of REST-stijl) die zijn ontworpen voor acties via resources, ondersteunen GraphQL-API's een bredere set gebruiksgevallen en richten ze zich op gegevenstypen, schema's en query's.

API Management worden de beveiligings-, verificatie- en autorisatieproblemen van het publiceren van GraphQL-API's aangepakt. Met API Management GraphQL-API's kunt u het volgende doen:

  • Voeg een GraphQL-service toe als API's via Azure Portal.
  • Beveilig GraphQL-API's door zowel bestaand toegangsbeheerbeleid als een nieuw beleid toe te passen om graphQL-specifieke aanvallen te beveiligen en beveiligen.
  • Verken het schema en voer testquery's uit op de GraphQL-API's in de Azure- en ontwikkelaarsportals.

Belangrijk

API Management GraphQL-API is momenteel in preview.

In dit artikel gaat u het volgende doen:

  • Meer informatie over de voordelen van het gebruik van GraphQL-API's.
  • Voeg een GraphQL-API toe aan uw API Management-exemplaar.
  • Test uw GraphQL-API.
  • Meer informatie over de beperkingen van uw GraphQL-API in API Management.

Vereisten

Een GraphQL-API toevoegen

  1. Navigeer naar API Management-exemplaar.

  2. Selecteer api's in het navigatiemenu aan de zijkant onder de sectie API's.

  3. Selecteer onder Een nieuwe API definiëren het GraphQL-pictogram.

    GraphQL-pictogram selecteren in de lijst met API's

  4. Selecteer volledig in het dialoogvenster en vul de vereiste formuliervelden in.

    Velden demonstreren voor het maken van GraphQL

    Veld Beschrijving
    Weergavenaam De naam waarmee uw GraphQL-API wordt weergegeven.
    Name Onbewerkte naam van de GraphQL-API. Wordt automatisch ingevuld wanneer u de weergavenaam typt.
    GraphQL API-eindpunt De basis-URL met de naam van uw GraphQL API-eindpunt.
    Bijvoorbeeld: https://example.com/your-GraphQL-name . U kunt ook het algemene GraphQL-eindpunt 'Star Wars' als demo gebruiken.
    Upload schemabestand maken Selecteer om door het schemabestand te bladeren en het te uploaden.
    Description Voeg een beschrijving van uw API toe.
    URL-schema Selecteer HTTP, HTTPS of Beide. Standaardselectie: beide.
    API-URL-achtervoegsel Voeg een URL-achtervoegsel toe om deze specifieke API in dit API Management identificeren. Het moet uniek zijn in dit API Management-exemplaar.
    Basis-URL Uneditable field displaying your API base URL
    Tags Koppel uw GraphQL-API aan nieuwe of bestaande tags.
    Producten Koppel uw GraphQL-API aan een product om deze te publiceren.
    Gateways Koppel uw GraphQL-API aan bestaande gateways. Standaardgatewayselectie: Beheerd.
    Versie van deze API? Selecteer voor versiebeheer uw GraphQL-API.
  5. Klik op Create.

Uw GraphQL-API testen

  1. Navigeer naar API Management-exemplaar.

  2. Selecteer api's in het navigatiemenu aan de zijkant onder de sectie API's.

  3. Selecteer onder Alle API's uw GraphQL-API.

  4. Selecteer het tabblad Testen om toegang te krijgen tot de testconsole.

  5. Onder Headers:

    1. Selecteer de header in de vervolgkeuzelijst Naam.
    2. Voer de waarde in het veld Waarde in.
    3. Voeg meer headers toe door + Koptekst toevoegen te selecteren.
    4. Verwijder headers met behulp van het prullenbakpictogram.
  6. Als u een product hebt toegevoegd aan uw GraphQL-API, moet u het productbereik toepassen onder Productbereik toepassen.

  7. Onder Query-editor:

    1. Selecteer ten minste één veld of subveld in de lijst in het zijmenu. De velden en subvelden die u selecteert, worden weergegeven in de queryeditor.

    2. Begin met typen in de query-editor om een query samen te stellen.

      Het toevoegen van velden aan de query-editor demonstreren

  8. Voeg onder Queryvariabelen variabelen toe om dezelfde query of wisselende query opnieuw te gebruiken en verschillende waarden door te geven.

  9. Klik op Verzenden.

  10. Bekijk het antwoord.

    Het antwoord van de testquery weergeven

  11. Herhaal de voorgaande stappen om verschillende nettoladingen te testen.

  12. Wanneer het testen is voltooid, sluit u de testconsole.

Beperkingen

  • Alleen GraphQL Pass Through wordt ondersteund.
  • Eén GraphQL-API in API Management komt overeen met slechts één GraphQL-back-end-eindpunt.

Volgende stappen