📖 OpenAPI/Swagger Viewer

JSON and simple YAML specifications are accepted.
API Browser
Loaded: {{ loadedSpecTitle }} ({{ loadedEndpointCount }} endpoints)
⚠️ {{ error }}

ℹ️ About OpenAPI/Swagger Viewer

OpenAPI/Swagger Viewer renders machine-readable API descriptions into interactive documentation. It supports OpenAPI 3.x and Swagger 2.0 documents in JSON or YAML so you can inspect paths, operations, parameters, request bodies, responses, schemas, examples, servers, and authentication metadata. The current official specification lives at the OpenAPI Specification.

Supported Formats:

  • OpenAPI 3.x: Modern OpenAPI specification (JSON or YAML)
  • Swagger 2.0: Legacy Swagger specification (JSON or YAML)
  • JSON Schema: Embedded data models and validation rules

Key Features:

  • Interactive API endpoint explorer with expandable sections
  • Request/response schema visualization
  • Example payload generation
  • Authentication method documentation
  • Server configuration display
  • Model schema browser with inheritance
  • Try-it-out functionality for testing endpoints

Use Cases:

  • API documentation review and validation
  • Developer onboarding and API exploration
  • API specification testing and debugging
  • Client SDK development reference
  • API design review and collaboration

Schema and format notes: OpenAPI 3.1 aligns its schema dialect with JSON Schema, whose current specifications are published at json-schema.org. YAML input should follow the YAML language rules from the official YAML specifications.

Limitations: rendering a document does not prove the API is reachable, secure, or compatible with every client. Remote references, vendor extensions, authentication flows, and "try it" requests may depend on CORS, network access, and the permissions configured by the API owner.

API Usage Example:

POST /api/tools/webdev/openapi-viewer
Content-Type: application/json

{
    "specification": "{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"Example API\", \"version\": \"1.0.0\"}}"
}
Ready