GraphQL API details

Edit online

webMethods API Gateway supports proxying an existing GraphQL endpoint and provides API management capabilities to clients such as authentication, and analytics. The GraphQL APIs can be accessed by using the HTTP GET and POST methods. You can create and deploy a GraphQL API by using the API Gateway UI or REST endpoints.

The following table lists the features that webMethods API Gateway supports for GraphQL.

Graph features Supported
Basic Graph 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 types, Interface type, Union type, Enum type Yes

The following table lists the webMethods API Gateway-specific features that are not supported for GraphQL API.

webMethods 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 Developer Portal No

The API details page 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 that are 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, Description, Version, Owner of the API, and the teams that the API is assigned to. In addition, you can also view the Active or Inactive status of the API, the maturity state of the API, and the date on which the API was created.
Technical information Displays the following endpoints of the API:
  • Native endpoints.
  • Gateway endpoints. 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 that are displayed in the API details page display the following details:

  • The Policies tab displays the policies that are 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 by clicking Export.
  • You can update an API by importing from file or from URL by clicking Update. This option is available when the API is in the deactivated state.
  • You can create a new version of the API by clicking Create new version
  • You can modify details of an API by clicking Edit. This option is available when the API is in the deactivated state.
  • You can activate an API by clicking Activate. If the API is already activated, you can deactivate it by clicking Deactivate.