Skip to content

Files

Latest commit

dlepowdlepow
Update graphql-api.md
May 31, 2022
bc503ef · May 31, 2022

History

History
70 lines (53 loc) · 3.7 KB

graphql-api.md

File metadata and controls

70 lines (53 loc) · 3.7 KB
title titleSuffix description ms.service author ms.author ms.topic ms.date ms.custom
Import a GraphQL API to Azure API Management using the portal | Microsoft Docs
Learn how to add an existing GraphQL service as an API in Azure API Management. Manage the API and enable queries to pass through to the GraphQL endpoint.
api-management
dlepow
danlep
how-to
05/19/2022
event-tier1-build-2022

Import a GraphQL API

[!INCLUDE api-management-graphql-intro.md]

In this article, you'll:

[!div class="checklist"]

  • Learn more about the benefits of using GraphQL APIs.
  • Add a GraphQL API to your API Management instance.
  • Test your GraphQL API.
  • Learn the limitations of your GraphQL API in API Management.

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.

Prerequisites

[!INCLUDE api-management-navigate-to-instance.md]

Add a GraphQL API

  1. Navigate to your API Management instance.

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

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

    :::image type="content" source="media/graphql-api/import-graphql-api.png" alt-text="Screenshot of selecting GraphQL icon from list of APIs.":::

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

    :::image type="content" source="media/graphql-api/create-from-graphql-schema.png" alt-text="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 API endpoint The base URL with your GraphQL API endpoint name.
    For example: https://example.com/your-GraphQL-name. You can also use a common "Star Wars" GraphQL endpoint such as https://swapi-graphql.azure-api.net/graphql 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 Select HTTP, HTTPS, or Both. Default selection: Both.
    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.
    Gateways Associate your GraphQL API with existing gateways. Default gateway selection: Managed.
    Version this API? Select to apply a versioning scheme to your GraphQL API.

  5. Select Create.

  6. After the API is created, browse the schema on the Design tab, in the Frontend section. :::image type="content" source="media/graphql-api/explore-schema.png" alt-text="Screenshot of exploring the GraphQL schema in the portal.":::

[!INCLUDE api-management-graphql-test.md]

[!INCLUDE api-management-define-api-topics.md]

Next steps

[!div class="nextstepaction"] Transform and protect a published API