OpenAPI / Swagger Preview

Render OpenAPI 3.x and Swagger 2.0 specs in JSON or YAML as API docs with endpoints grouped by tag, parameters and schemas.

OpenAPI / Swagger spec (JSON or YAML)13,084 chars

openapi: "3.0.3"
info:
  title: Pet Store API
  version: "1.2.0"
  description: A sample pet store API demonstrating OpenAPI 3.0 features. Manage your pets, orders, and user accounts.
  contact:
    name: API Support
    email: support@petstore.example.com
    url: https://petstore.example.com/support
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.petstore.example.com/v1
    description: Production
  - url: https://staging-api.petstore.example.com/v1
    description: Staging
  - url: http://localhost:3000/v1
    description: Local development
tags:
  - name: pets
    description: Everything about your pets
  - name: orders
    description: Access to pet store orders
  - name: users
    description: User account operations
paths:
  /pets:
    get:
      tags: [pets]
      summary: List all pets
      description: Returns a paginated list of pets. Supports filtering by status and species.
      operationId: listPets
      parameters:
        - name: limit
          in: query
          description: Maximum number of pets to return (1-100)
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          description: Number of pets to skip for pagination
          required: false
          schema:
            type: integer
        - name: status
          in: query
          description: Filter by pet status
          required: false
          schema:
            type: string
            enum: [available, pending, sold]
        - name: species
          in: query
          description: Filter by species
          required: false
          schema:
            type: string
      responses:
        "200":
          description: A paginated list of pets
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique pet identifier
                        name:
                          type: string
                          description: The pet's name
                        species:
                          type: string
                          description: Species of the pet
                        status:
                          type: string
                          enum: [available, pending, sold]
                        createdAt:
                          type: string
                          format: date-time
                  total:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
        "400":
          description: Invalid query parameters
        "401":
          description: Authentication required
    post:
      tags: [pets]
      summary: Create a new pet
      description: Add a new pet to the store inventory.
      operationId: createPet
      requestBody:
        required: true
        description: Pet object to be added
        content:
          application/json:
            schema:
              type: object
              required: [name, species]
              properties:
                name:
                  type: string
                  description: The pet's name
                  minLength: 1
                  maxLength: 100
                species:
                  type: string
                  description: Species of the pet
                breed:
                  type: string
                  description: Breed of the pet
                age:
                  type: integer
                  description: Age in years
                  minimum: 0
                tags:
                  type: array
                  items:
                    type: string
                  description: Tags for categorization
      responses:
        "201":
          description: Pet created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  species:
                    type: string
                  status:
                    type: string
                  createdAt:
                    type: string
                    format: date-time
        "400":
          description: Invalid request body
        "401":
          description: Authentication required
        "422":
          description: Validation error
  /pets/{petId}:
    get:
      tags: [pets]
      summary: Get a pet by ID
      operationId: getPet
      parameters:
        - name: petId
          in: path
          required: true
          description: The ID of the pet to retrieve
          schema:
            type: integer
      responses:
        "200":
          description: Pet details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  species:
                    type: string
                  breed:
                    type: string
                  age:
                    type: integer
                  status:
                    type: string
                  tags:
                    type: array
                    items:
                      type: string
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
        "404":
          description: Pet not found
    put:
      tags: [pets]
      summary: Update a pet
      operationId: updatePet
      parameters:
        - name: petId
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                species:
                  type: string
                breed:
                  type: string
                age:
                  type: integer
                status:
                  type: string
                  enum: [available, pending, sold]
                tags:
                  type: array
                  items:
                    type: string
      responses:
        "200":
          description: Pet updated successfully
        "400":
          description: Invalid request body
        "404":
          description: Pet not found
    delete:
      tags: [pets]
      summary: Delete a pet
      operationId: deletePet
      parameters:
        - name: petId
          in: path
          required: true
          schema:
            type: integer
      responses:
        "204":
          description: Pet deleted successfully
        "404":
          description: Pet not found
  /orders:
    get:
      tags: [orders]
      summary: List orders
      operationId: listOrders
      parameters:
        - name: status
          in: query
          description: Filter by order status
          schema:
            type: string
            enum: [placed, approved, delivered, cancelled]
      responses:
        "200":
          description: List of orders
    post:
      tags: [orders]
      summary: Place a new order
      operationId: createOrder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [petId, quantity]
              properties:
                petId:
                  type: integer
                  description: ID of the pet to order
                quantity:
                  type: integer
                  minimum: 1
                shipDate:
                  type: string
                  format: date-time
                  description: Requested ship date
      responses:
        "201":
          description: Order placed successfully
        "400":
          description: Invalid order data
  /orders/{orderId}:
    get:
      tags: [orders]
      summary: Get order by ID
      operationId: getOrder
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: Order details
        "404":
          description: Order not found
    patch:
      tags: [orders]
      summary: Update order status
      operationId: updateOrderStatus
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [status]
              properties:
                status:
                  type: string
                  enum: [placed, approved, delivered, cancelled]
      responses:
        "200":
          description: Order updated
        "404":
          description: Order not found
  /users/register:
    post:
      tags: [users]
      summary: Register a new user
      operationId: registerUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [username, email, password]
              properties:
                username:
                  type: string
                  minLength: 3
                  maxLength: 50
                email:
                  type: string
                  format: email
                password:
                  type: string
                  format: password
                  minLength: 8
      responses:
        "201":
          description: User created
        "409":
          description: Username or email already exists
  /users/login:
    post:
      tags: [users]
      summary: Login
      operationId: loginUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [email, password]
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                  format: password
      responses:
        "200":
          description: Login successful, returns JWT token
        "401":
          description: Invalid credentials
  /users/me:
    get:
      tags: [users]
      summary: Get current user profile
      operationId: getCurrentUser
      responses:
        "200":
          description: Current user details
        "401":
          description: Not authenticated
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT authentication token
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for service-to-service auth
  schemas:
    Pet:
      type: object
      required: [id, name, species, status]
      properties:
        id:
          type: integer
          description: Unique identifier
        name:
          type: string
          description: Pet name
        species:
          type: string
          description: Species
        breed:
          type: string
          description: Breed
        age:
          type: integer
          description: Age in years
        status:
          type: string
          enum: [available, pending, sold]
        tags:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Order:
      type: object
      properties:
        id:
          type: integer
        petId:
          type: integer
        quantity:
          type: integer
        status:
          type: string
          enum: [placed, approved, delivered, cancelled]
        shipDate:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    User:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
        email:
          type: string
          format: email
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string

Pet Store API

v1.2.0OpenAPI 3.0.3

A sample pet store API demonstrating OpenAPI 3.0 features. Manage your pets, orders, and user accounts.

Contact: API SupportEmail: support@petstore.example.comLicense: Apache 2.0

12 endpoints4 schemas3 tags

Servers

Security schemes

bearerAuthhttp

Scheme: bearer (JWT)

JWT authentication token

apiKeyapiKey

In: header / Name: X-API-Key

API key for service-to-service auth

12 endpoints

pets5 endpoints

Everything about your pets

orders4 endpoints

Access to pet store orders

users3 endpoints

User account operations

Schemas4 definitions

Supported features

Spec versions

OpenAPI 3.0.x / 3.1.x and Swagger 2.0. Auto-detects JSON or YAML format.

Endpoints

GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE. Grouped by tag with parameters, request bodies, and responses.

Schemas

Component/definition schemas with $ref resolution. Displays property types, required fields, and descriptions.

Security

HTTP Bearer, API Key, OAuth2, and OpenID Connect security scheme display.

Updated October 2, 2026. Provided as is. Check the output before you rely on it in production.

How to use OpenAPI / Swagger Preview

1

Paste an OpenAPI or Swagger spec

Paste an OpenAPI 3.0/3.1 or Swagger 2.0 spec as JSON or YAML, or load the sample. The format is detected automatically.
2

Navigate endpoints

Endpoints are grouped by tag. Expand any endpoint to see its parameters, request body and responses, or use Expand All and Collapse All.
3

Search the spec

Filter endpoints by path, method, summary or operationId to find what you need in a large spec.
4

Review schemas and security

Check response schemas for success and error cases, the component schemas, servers and the security schemes the API declares.
5

Copy endpoint URLs

Copy the full URL for any endpoint, including the server base, for curl, a REST client or your code.

Questions and answers

What is OpenAPI / Swagger Preview?

OpenAPI, formerly Swagger, is a JSON or YAML format describing a REST API's endpoints, parameters, request bodies and responses. This previewer parses OpenAPI 3.x and Swagger 2.0 specs and renders endpoints grouped by tag, with parameters, schemas resolved from $ref, servers and security schemes.

Does it support both OpenAPI 3.x and Swagger 2.0?

Yes. The tool supports both OpenAPI 3.0/3.1 and legacy Swagger 2.0 specifications. It accepts both JSON and YAML formats and renders the documentation the same way regardless of the spec version.

For AI agents: how to call this tool

Machine-readable contract, endpoints and examples. Humans can ignore this section.

Best Path For Builders

Browser workflow

Runs instantly in the browser with private local processing and copy/export-ready output.

Browser Workflow

This tool is optimized for instant in-browser execution with local data handling. Run it here and copy/export the output directly.

/openapi-preview/

For automation planning, fetch the canonical contract at /api/tool/openapi-preview.json.

OpenAPI / Swagger Preview