About openapi viewer
OpenAPI (formerly Swagger) describes REST APIs in a standard file. The viewer shows the title, version, servers and endpoints as a readable summary.
Why it matters
- Clients and documentation can be generated from the file.
- It acts as the contract between front end and back end.
- Tools can test the API against it.
A worked example
Paste a file and the viewer lists the title, version, servers, tags and every endpoint with its method, such as GET /users and POST /users. It makes a large specification understandable at a glance, without a heavy documentation tool.
Reading an OpenAPI file
- paths lists the endpoints and their operations.
- components holds reusable schemas, parameters and security schemes.
- Each operation describes parameters, request body and possible responses.
Versions of the standard
Swagger 2.0 files use the swagger key, while OpenAPI 3.x files use openapi. The viewer understands both, but newer features such as multiple servers and callbacks exist only in version 3.
