OpenAPI Viewer Guide
Read an OpenAPI or Swagger document and list its operations, parameters and responses.
A short companion for OpenAPI Viewer: when it is useful, what it expects, and what to check before using the result.
What it does
Paste an OpenAPI or Swagger document and read it as a list of operations rather than as a wall of YAML. Each endpoint shows its method, its parameters, its request body and the responses it can return, with references resolved so a schema appears where it is used.
Use the tool
Open OpenAPI Viewer, add the input the tool asks for, run it, and check the output before using it elsewhere.
Input and output
- Input: text.
- Output: text.
- Category: Web.
Privacy and processing
Processing happens locally in your browser. This tool does not upload the input to ilham.dev.
Questions
Does it fetch my specification from a URL?
No. The document is read as text in the page, and a reference to another file is shown as a reference rather than followed. That keeps the page working offline and keeps a private spec private.
Which versions are supported?
OpenAPI 3.0 and 3.1 as well as Swagger 2.0. The overview writes down which one it found, and a Swagger 2 document's host, basePath and schemes are shown as the server.
How deep does a schema go?
Nested objects are expanded a couple of levels and then summarised as object, so one schema cannot flood the page. The shape is still clear, and the full definition is in the document you pasted.
Related guide
For broader background, see API Testing.