ssentiago5k downloadsIntegrate OpenAPI specification management with features for version control, visualization, editing, and easy navigation of API specs.
Integrate OpenAPI specification editing and rendering into Obsidian: write and maintain Swagger UI documentation without switching between applications.
I once wrote documentation for my small project directly in Obsidian while working on the database. Later, I needed to work with API documentation, so I started looking for suitable solutions among Obsidian plugins. Not finding any good options, I decided to create a plugin that allows writing Swagger UI documentation directly in Obsidian, without the need to switch between different applications. I hope I’ve managed to create something useful. If you have any suggestions for improvement, feel free to leave any issues here!
. obsidian/plugins/openapi-renderer
directory
(create it if it doesn’t exist)Settings -> Community plugins, click on Browse button and search for
OpenAPI Renderer. Install itNote: You need to enable the Detect all file extension option in Settings -> Files and Links.
The plugin has 3 main functions:
Optionally the plugin can register all .yaml, .yml and .json files to open in
OpenAPI View by default. This is disabled by default so the configs of other plugins
stay untouched. You can enable it in plugin settings: OpenAPI View -> Register YAML and JSON for processing by default?. Either way you can always open a specification via the
file context menu item Open in OpenAPI View.
There are two ways to open the view for editing or previewing specifications:
Register YAML and JSON for processing by default? is enabled)Open in OpenAPI ViewBoth methods will open the OpenAPI View, which has two modes:
How it looks:
Available actions in the top actions bar:
Both modes also have a theme toggle (dark / light) with optional sync to the Obsidian theme.
The export produces a self-contained HTML page: Swagger UI styles and runtime are inlined,
so the page opens offline in any browser. By default exports are written to the exports
folder in the vault root; the folder is configurable in plugin settings and created on
demand.
Two export commands are available in the command palette:
Special thanks to mnaoumov for valuable insights and contributions, which greatly supported the development of this plugin.
If you encounter any bugs or unexpected behavior, please open an issue on GitHub. If you want to offer a new feature, feel free to suggest.
Your involvement makes the plugin better for everyone.