A lightweight, powerful, and theme-aware VS Code extension to preview OpenAPI YAML and JSON files using a high-fidelity Swagger UI. It works entirely offline with local assets, ensuring your API definitions never leave your environment.
- High-Fidelity Rendering: Full Swagger UI integration for a professional experience.
- Theme Aware: Seamlessly adjusts to your VS Code dark and light themes.
- Offline Ready: No CDN dependencies; uses local assets for maximum privacy and speed.
- Flexible Access:
- Command Palette (
Cmd+Alt+O/Ctrl+Alt+O) - Editor title button (quick-access icon)
- Explorer context menu (right-click any YAML/JSON)
- Editor context menu
- Command Palette (
- Auto-Detection: Smartly recognizes OpenAPI/Swagger files to stay out of your way when not needed.
- Open any
.yaml,.yml, or.jsonOpenAPI/Swagger file. - Click the OpenAPI Viewer icon in the editor title bar (top-right).
- Alternatively, use the command palette (
Cmd+Shift+P) and search for Simple OpenAPI Viewer: Open Current File.
- VS Code version 1.74.0 or higher.
- A valid OpenAPI (2.0, 3.0, 3.1) or Swagger definition file.
You can install the extension from your preferred marketplace:
Alternatively, open VS Code and search for Simple OpenAPI Viewer.
Contributions are welcome! Please feel free to submit a Pull Request or open an issue on GitHub.
Made with ❤️ by Rahul Dhole
