Skip to content
Docs

Settings — API Docs

Navigate to: Settings → API Docs

What it shows: Auto-generated OpenAPI 3.0 documentation for all configured gateway routes. Includes request/response schemas derived from your Schema Validation rules.

Step-by-step:

  1. Navigate to Settings → API Docs.
  2. The Swagger UI renders all gateway routes as explorable endpoints.
  3. Click any endpoint to expand its request schema, parameters, and example responses.
  4. Click Try it out → Execute to send a test request directly from the docs UI (uses your current session token).
  5. Click Download OpenAPI Spec (top-right) to export the spec as a JSON file for use with Postman, Insomnia, or code generators.

How to test: Add a Schema Validation rule to a route, then reload API Docs — the route’s request schema in Swagger should reflect the JSON Schema you defined.