https://github.com/rahuldhole/simple-openapi-viewer

VS Code extension to quickly view openapi file. no BS
https://github.com/rahuldhole/simple-openapi-viewer

development tools vscode

Last synced: 2 months ago
JSON representation

VS Code extension to quickly view openapi file. no BS

• Host: GitHub
• URL: https://github.com/rahuldhole/simple-openapi-viewer
• Owner: rahuldhole
• License: mit
• Created: 2026-04-15T18:38:34.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2026-04-15T21:11:00.000Z (2 months ago)
• Last Synced: 2026-04-15T21:16:30.757Z (2 months ago)
• Topics: development, tools, vscode
• Language: JavaScript
• Homepage: https://simple-openapi-viewer.rahuldhole.com/
• Size: 2.61 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Simple OpenAPI Viewer

[![Visual Studio Marketplace](https://badgen.net/vs-marketplace/v/RahulDhole.simple-openapi-viewer?color=007acc&label=Marketplace&icon=visualstudio)](https://marketplace.visualstudio.com/items?itemName=RahulDhole.simple-openapi-viewer)

[![Open VSX Registry](https://badgen.net/open-vsx/v/RahulDhole/simple-openapi-viewer?color=33b3b3&label=Open%20VSX&icon=visualstudio)](https://open-vsx.org/extension/RahulDhole/simple-openapi-viewer)

[![License: MIT](https://badgen.net/badge/license/MIT/yellow)](LICENSE)

![Simple OpenAPI Viewer Hero](https://github.com/rahuldhole/simple-openapi-viewer/raw/HEAD/resources/hero.png)

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.

## ✨ Features

- **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

- **Auto-Detection**: Smartly recognizes OpenAPI/Swagger files to stay out of your way when not needed.

## 🚀 Getting Started

1. Open any `.yaml`, `.yml`, or `.json` OpenAPI/Swagger file.

2. Click the **OpenAPI Viewer** icon in the editor title bar (top-right).

3. Alternatively, use the command palette (`Cmd+Shift+P`) and search for **Simple OpenAPI Viewer: Open Current File**.

## 🛠️ Requirements

- VS Code version 1.74.0 or higher.

- A valid OpenAPI (2.0, 3.0, 3.1) or Swagger definition file.

## 📦 Installation

You can install the extension from your preferred marketplace:

- **[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=RahulDhole.simple-openapi-viewer)**

- **[Open VSX Registry](https://open-vsx.org/extension/RahulDhole/simple-openapi-viewer)**

Alternatively, open VS Code and search for `Simple OpenAPI Viewer`.

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue on [GitHub](https://github.com/rahuldhole/simple-openapi-viewer).

---

Made with ❤️ by [Rahul Dhole](https://github.com/rahuldhole)