GraphQL for OpenAPI
Insomnia Designer has auto-detection for GraphQL APIs documented through OpenAPI. To enable auto-detection your GraphQL API must be documented with the following values before generating debugging requests:
- Path must be
/graphql
- Method must be
POST
- Request body must be
application/json
and must contain a propertyquery
with the typestring
- Response body must be
application/json
Below you can see an example of a described GraphQL API endpoint that will trigger auto-detection with a pre-populated request body that will show up in the debug mode requests:
paths: /graphql: post: summary: 'My GraphQL API Endpoint' description: 'My GraphQL API Endpoint' operationId: 'graphql' responses: '200': description: 'Successfull Query' content: application/json: schema: type: object requestBody: content: application/json: schema: type: object example: query: > { allFilms { films { title } } } properties: query: type: string