Skip to main content

Swagger / OpenAPI

Kvery can publish interactive API documentation for a group's shared queries. Each published query becomes a documented endpoint in a Swagger UI page, so consumers can explore and try your endpoints without you hand-writing API docs.

What you get​

  • A Swagger UI page describing the group's published endpoints.
  • An underlying OpenAPI definition that other tools can import.
  • A shareable link, addressed by a hash, that you can hand to API consumers.

Per-group settings​

Swagger is configured per group. You set the Swagger options for a group and Kvery builds the documentation from the queries that are published there — their paths, the HTTP methods they answer, and the parameters they accept (derived from your form variables).

Accessing it​

The documentation is served at a Swagger view URL identified by a hash:

https://app.kvery.io/swagger/{hash}

Consumers open that link to read the docs and try requests interactively; tools can fetch the matching OpenAPI data endpoint to import the definition.

Tips​

  • Give your queries clear names and descriptions — they surface in the generated docs. The AI assistant can draft descriptions for you.
  • Keep parameter names meaningful; they become the documented request parameters.
  • Combine Swagger with API security so the documented endpoints stay protected.