Developer Tools

OpenAPI & Swagger Viewer

View and interact with OpenAPI specification files in JSON or YAML offline.

100% client-side: your files never leave your browser

OpenAPI Specification (YAML or JSON)

openapi: 3.0.0
info:
  title: Sample Petstore API
  description: A sample API to illustrate OpenAPI/Swagger viewer capabilities.
  version: 1.0.1
servers:
  - url: https://api.petstore.example.com/v1
    description: Production server
  - url: https://staging-api.petstore.example.com/v1
    description: Staging server
paths:
  /pets:
    get:
      summary: List all pets
      description: Returns a list of all pets in the store database.
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: A successful response matching pet list.
    post:
      summary: Create a pet
      description: Add a new pet record to the store repository.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                tag:
                  type: string
      responses:
        '201':
          description: Pet created successfully.
  /pets/{petId}:
    get:
      summary: Info for a specific pet
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request.

Provide a valid OpenAPI/Swagger specification on the left to view documentation.