Playground API

OpenAPI 3.0

OpenAPI 3.0 Specification (Swagger)

Overview

OpenAPI 3.0 is the industry-standard specification language for HTTP REST APIs. It allows developers to generate interactive Swagger UI documentation, client SDKs, and mock servers automatically.

Using Our OpenAPI 3.0 Collection

We've prepared a comprehensive OpenAPI 3.0 collection that includes all available endpoints in our API, properly organized and documented. This collection will help you:

  1. View interactive endpoint schemas and parameters in Swagger UI or Redoc.
  2. Auto-generate strongly typed client SDKs in TypeScript, Python, Swift, or Rust.
  3. Validate request and response JSON schemas programmatically.
  4. Import directly into backend proxies and API gateways.
OpenAPI 3.0 Workspace Preview
1
npx @openapitools/openapi-generator-cli generate \
2
-i /api/v1/downloads/openapi.json \
3
-g typescript-axios \
4
-o ./src/api-client

Getting Started

  1. Download our OpenAPI 3.0 specification file by clicking the link below.
  2. Open Swagger Editor, Redoc, or Stoplight Studio.
  3. Import the JSON file to view full interactive documentation.
  4. Use openapi-generator-cli to generate client code for your project.
Download OpenAPI 3.0 Collection
Prev: GraphQL GatewayNext: Postman Collection