Specification Structure

The OpenAPI specification represents the GraphQL API as REST-style endpoints:

  • Query endpoints โ€” Each GraphQL query becomes a GET endpoint at /graphql/query/{queryName} with query parameters.

  • Mutation endpoints โ€” Each GraphQL mutation becomes a POST endpoint at /graphql/mutation/{mutationName} with a JSON request body.

  • Schema components โ€” All GraphQL types, inputs, and enums are defined as reusable schema components.

Each endpoint includes complete documentation, parameter definitions, request and response schemas, and metadata from the GraphQL schema.