Import a GraphQL API

APPLIES TO: All API Management tiers

In API Management, you can add a GraphQL API in one of two models: pass-through to an existing GraphQL endpoint, or import a GraphQL schema and create a synthetic GraphQL API with custom field resolvers. For more information, see the GraphQL overview.

In this article, you'll:

  • Add a pass-through GraphQL API to your API Management instance.
  • Test your GraphQL API.

If you want to import a GraphQL schema and set up field resolvers using REST or SOAP API endpoints, see Import a GraphQL schema and set up field resolvers.


Add a GraphQL API

  1. In the Azure portal, navigate to your API Management instance.

  2. In the left menu, select APIs > + Add API.

  3. Under Define a new API, select the GraphQL icon.

    Screenshot of selecting GraphQL icon from list of APIs.

  4. In the dialog box, select Full and complete the required form fields.

    Screenshot of fields for creating a GraphQL API.

    Field Description
    Display name The name by which your GraphQL API will be displayed.
    Name Raw name of the GraphQL API. Automatically populates as you type the display name.
    GraphQL type Select Pass-through GraphQL to import from an existing GraphQL API endpoint.
    GraphQL API endpoint The base URL with your GraphQL API endpoint name.
    For example: You can also use a common "swapi" GraphQL endpoint such as as a demo.
    Upload schema Optionally select to browse and upload your schema file to replace the schema retrieved from the GraphQL endpoint (if available).
    Description Add a description of your API.
    URL scheme Make a selection based on your GraphQL endpoint. Select one of the options that includes a WebSocket scheme (WS or WSS) if your GraphQL API includes the subscription type. Default selection: HTTP(S).
    API URL suffix Add a URL suffix to identify this specific API in this API Management instance. It has to be unique in this API Management instance.
    Base URL Uneditable field displaying your API base URL
    Tags Associate your GraphQL API with new or existing tags.
    Products Associate your GraphQL API with a product to publish it.
    Version this API? Select to apply a versioning scheme to your GraphQL API.
  5. Select Create.

  6. After the API is created, browse or modify the schema on the Design tab. Screenshot of exploring the GraphQL schema in the portal.

Test your GraphQL API

  1. Navigate to your API Management instance.

  2. From the side navigation menu, under the APIs section, select APIs.

  3. Under All APIs, select your GraphQL API.

  4. Select the Test tab to access the test console.

  5. Under Headers:

    1. Select the header from the Name drop-down menu.
    2. Enter the value to the Value field.
    3. Add more headers by selecting + Add header.
    4. Delete headers using the trashcan icon.
  6. If you've added a product to your GraphQL API, apply product scope under Apply product scope.

  7. Under Query editor, either:

    1. Select at least one field or subfield from the list in the side menu. The fields and subfields you select appear in the query editor.

    2. Start typing in the query editor to compose a query.

      Screenshot of adding fields to the query editor.

  8. Under Query variables, add variables to reuse the same query or mutation and pass different values.

  9. Select Send.

  10. View the Response.

    Screenshot of viewing the test query response.

  11. Repeat preceding steps to test different payloads.

  12. When testing is complete, exit test console.

Test a subscription

If your GraphQL API supports a subscription, you can test it in the test console.

  1. Ensure that your API allows a WebSocket URL scheme (WS or WSS) that's appropriate for your API. You can enable this setting on the Settings tab.

  2. Set up a subscription query in the query editor, and then select Connect to establish a WebSocket connection to the backend service.

    Screenshot of a subscription query in the query editor.

  3. Review connection details in the Subscription pane.

    Screenshot of Websocket connection in the portal.

  4. Subscribed events appear in the Subscription pane. The WebSocket connection is maintained until you disconnect it or you connect to a new WebSocket subscription.

    Screenshot of GraphQL subscription events in the portal.

Secure your GraphQL API

Secure your GraphQL API by applying both existing authentication and authorization policies and a GraphQL validation policy to protect against GraphQL-specific attacks.

Next steps