Simple Swagger Viewer

Live Swagger UI preview for OpenAPI 3 / Swagger 2 documents written in YAML or JSON.

Usage

1. Open an OpenAPI / Swagger .yaml, .yml or .json file.
2. Run Simple Swagger Viewer: Open Preview to the Side (Shift+Alt+P), or click the preview icon in the editor title bar.

The preview follows your edits as you type. When the document cannot be parsed, the error is shown at the top of the preview and the last valid rendering stays visible until the document parses again.

Commands

Limitations

• External $refs pointing to other local files are not resolved.
• "Try it out" requests are sent from the webview and are subject to the target server's CORS policy.

Development

npm install
npm run build   # or press F5 in VS Code
npm test

Release to both the Visual Studio Marketplace and Open VSX:

npx vsce login statiolake     # once
export OVSX_PAT=...           # Open VSX access token
npm run publish

License

MIT. Swagger UI is bundled under the Apache License 2.0 (see media/swagger-ui/LICENSE in the package).