OpenAPI Viewer

Read a Swagger or OpenAPI spec as a clear list of endpoints, parameters, request bodies, responses and schemas, and export it as Markdown docs.

Processed on your device. Files are not uploaded

How to view an OpenAPI or Swagger spec

  1. Paste your spec

    Paste an OpenAPI 3 or Swagger 2.0 file in YAML or JSON, or press Try an example.

  2. Search or switch views

    Filter endpoints by path, method or tag, or switch to the list of schemas.

  3. Copy the docs

    Copy or download the endpoint list as Markdown for a README or wiki.

Worked example

This is what OpenAPI Viewer gives for its own sample values. Open the tool above and change anything to try your own.

OpenAPI or Swagger spec (YAML or JSON)

openapi: 3.0.3
info:
  title: Pet Store
  version: 1.0.0
servers:
  - url: https://api.example.com/v1
paths:
  /pets:
    get:
      summary: List pets
      operationId: listPets
      parameters:
        - { name: limit, in: query, schema: { type: integer, minimum: 1, maximum: 50 } }
        - { name: status, in: query, schema: { type: string, enum: [available, sold] } }
...
Search endpoints
Show
Endpoints

Documentation as Markdown

# Pet Store (1.0.0)

Servers: https://api.example.com/v1

## GET /pets

List pets

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| limit | query | integer | no |  |
| status | query | available | sold | no |  |

| Status | Description | Body |
...

Result

API
Pet Store 1.0.0
Format
OpenAPI 3.0.3
Endpoints
3
Schemas
3
MethodPathSummaryParametersRequest bodyResponses
GET/petsList petslimit (query), status (query)200 Pet[]
POST/petsAdd a petNewPet (application/json)201 Pet, 400 Error
GET/pets/{petId}Get one petpetId (path, required)200 Pet, 404

When to use OpenAPI Viewer

Someone sent you a swagger.json or openapi.yaml and you want to see what endpoints it has without installing Swagger UI.

You are writing a README or wiki page and need a tidy Markdown list of the endpoints, parameters and responses.

Tips for a better OpenAPI Viewer result

Type a tag, a method or part of a path in the search box to narrow a large spec down to the area you are working on.

Switch to the schema view to see each model's required fields, which the endpoint table only names.

OpenAPI Viewer: limits and what to check

Descriptions written in Markdown are shown as plain text in the table, so long descriptions are best read in the exported docs.

OpenAPI 3.1 webhooks are not listed, since they describe calls the API makes to you rather than endpoints you call.

About OpenAPI Viewer

Read an API spec without setting anything up. Every endpoint is listed with its method, path, summary, parameters, request body and responses, and parameters shared by a whole path are included. The schema view lists each named model with its properties and required fields.

FAQs

Which versions are supported?

Swagger 2.0, OpenAPI 3.0 and OpenAPI 3.1, in YAML or JSON.

Is this the same as Swagger UI?

It shows the same information in a compact table and Markdown, without the try-it-out buttons, so it works offline and keeps your spec on your device.

Why is an endpoint missing?

Only the HTTP methods under paths are listed. Webhooks in OpenAPI 3.1 and vendor extensions are skipped.

Related tools