Skip to content
Instruo

Developer

OpenAPI Viewer

Explore complete OpenAPI JSON or YAML documents, including operations, schemas, and responses.

Input stays in this browser

Explore every part of an OpenAPI document locally: operations, schemas, parameters, responses, and raw data.

Example API

OpenAPI 3.0.3

2 operations2 reusable components

A small API showing request bodies, parameters, and responses.

API context

Servers

https://api.example.com/v1

Production

Operations

2 total
GET/userslistUsers

List users

Parameters (1) 
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "default": 20
    }
  }
]
Responses (1)
200A page of users
{
  "description": "A page of users",
  "content": {
    "application/json": {
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/User"
        }
      }
    }
  }
}
POST/userscreateUser

Create user

Request body 
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UserInput"
      }
    }
  }
}
Responses (1)
201Created
{
  "description": "Created",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/User"
      }
    }
  }
}

Reusable components

schemas (2)
User
{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
UserInput
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    }
  }
}
Raw parsed document
{
  "openapi": "3.0.3",
  "info": {
    "title": "Example API",
    "version": "1.0.0",
    "description": "A small API showing request bodies, parameters, and responses."
  },
  "servers": [
    {
      "url": "https://api.example.com/v1",
      "description": "Production"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "List users",
        "operationId": "listUsers",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of users",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/User"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create user",
        "operationId": "createUser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserInput"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "UserInput": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Usage

Paste an OpenAPI 3 or Swagger 2 document to inspect servers, tags, security schemes, every operation, parameters, request bodies, responses, reusable components, and the raw parsed document. JSON and YAML are supported.

Privacy

Specifications are parsed locally and never uploaded.