GraphQL
Theneo documents GraphQL APIs effortlessly: import a .graphql schema and the full type system is parsed.
How Theneo parses your GraphQL schema
Theneo automatically structures and documents every part of your schema, so developers can understand and interact with your API at a glance.
Query
Query
- Definition: a read-only fetch operation, akin to a
GETin REST. - Theneo's parsing: Theneo interprets
Querytype definitions so clients can request specific data, grouping each query under theQuerycategory with its parameters and return type.
Mutation
Mutation
- Definition: how you create, update, or delete data, similar to
POST,PUT,PATCH, orDELETEin REST. - Theneo's parsing: any defined mutations are parsed and displayed with details on how clients can modify data.
Subscription
Subscription
- Definition: maintains a persistent connection so clients receive real-time updates.
- Theneo's parsing: subscriptions are parsed and categorized, explaining how clients establish a connection to listen for events.
Objects
Objects
- Definition: named fields that each return a specific type, the building blocks of your API.
- Theneo's parsing: objects are displayed with their fields and types, showing the shape of data clients can expect.
Scalars
Scalars
- Definition: primitive types (
Int,Float,String,Boolean) that resolve to a single value, the leaves of a query. - Theneo's parsing: Theneo highlights these fundamental types and where they're used within object fields.
Directives
Directives
- Definition: a way to dynamically alter the execution of a query or mutation.
- Theneo's parsing: any directives are documented with their use cases, such as conditionally including or skipping fields.
Enums
Enums
- Definition: a scalar restricted to a set of allowed values, validating that arguments are one of them.
- Theneo's parsing: enums are parsed and documented, showing the fixed set of options for fields of that type.
Unions
Unions
- Definition: similar to interfaces, but without specifying common fields between types.
- Theneo's parsing: unions are parsed to illustrate how a field can return an object that could be one of several types.
Each component plays a role in defining the capabilities of your API, and Theneo documents them all automatically, giving you a robust, flexible reference with zero manual effort.
Body Parameters
weekNumberint Required
Response
200
Object
Response Attributes
weeklyAdventureobject
Show child attributes
Was this section helpful?
POST
/
Select
1
Response
Was this section helpful?