API Gateway 10.11 | Using API Gateway | APIs | Viewing API List and API Details | GraphQL API Details
 
GraphQL API Details
API Gateway supports proxying an existing GraphQL endpoint and provides API management capabilities to clients like authentication, analytics, and so on. The GraphQL APIs can be accessed using the HTTP GET and POST methods. You can create and deploy a GraphQL API using the API Gateway UI or REST endpoints.
The following table lists the features that API Gateway supports for GraphQL.
GraphQL Features
Supported
Basic GraphQL concepts:
*Schema
*Operations
*Types
Yes
Root operations for resources:
*Query
*Mutation
Yes
Root operations for resources: Subscription
No
Input and output data types:
*Scalar type
*Object type
*Interface type
*Union type
*Enum type
Yes
The following table lists the API Gateway-specific features that are not supported for GraphQL API.
API Gateway Features for GraphQL
Supported
API tagging
No
API mocking
No
Policy scopes
No
Packages and plan
No
Adding or updating GraphQL schema types
No
Publishing GraphQL API to API Portal
No
The API details view for a GraphQL API displays the details of the API such as basic and technical information, operations available, and specifications. You can also view the policies enforced, registered applications, and the API-specific analytics.
The table lists the API details displayed for the API:
Field
Description
Basic information
Displays the information about the API, such as Name, Version, Owner of the API, the teams that the API is assigned to, Active or Inactive status of the API , the maturity state of the API, the date on which the API was created, and a brief description of the API.
Technical information
Displays the following endpoints of the API:
*Native endpoint(s).
*Gateway endpoint(s). Displays these endpoints when the API is deployed to a gateway.
*Service Registry display name. Displays the name of the service registry where the API is deployed.
Operations
Displays a list of operations available in the API sorted alphabetically.
Operations are displayed along with their type (Query and Mutation).
Documentation
Displays a list of specifications for the API.
Various tabs displayed in the API details page display the following details:
*The Policies tab displays the policies enforced for the API.
*The Applications tab displays all the registered applications with the API.
*The Analytics tab displays the API-specific analytics for the time interval selected.
You can perform the following operations from the API details page:
*You can export an API using the Export button. For more information about exporting APIs, see Exporting APIs.
*You can update an API by importing from file or from URL by clicking the Update button. This option is available when the API is in the deactivated state. For more information about updating APIs, see Updating APIs.
*You can create a new version of the API by clicking the Create new version button. For more information about versioning APIs, see Versioning APIs.
*You can modify details of an API by clicking the Edit button. This option is available when the API is in the deactivated state. For more information about modifying API details, see Modifying API Details.
*You can activate an API by clicking the Activate button. If the API is already activated, you can deactivate it by clicking the Deactivate button.