mkdocs-render-swagger-plugin
MKDocs plugin for rendering swagger & openapi files.
Decision gist · record as of 2026-08-14
Yes, if you are building MkDocs documentation and want to embed interactive OpenAPI/Swagger schemas with minimal setup. The low install friction and permissive license make it straightforward to add. However, be aware that maintenance is dormant—if you encounter issues or need support for newer OpenAPI versions, you may need to fork or patch the plugin yourself. Suitable for stable, self-contained documentation projects.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.8 or later and an existing mkdocs project; OpenAPI files must conform to the OpenAPI specification.
- Low friction install as a pure Python wheel with a single runtime dependency on mkdocs.
- Maintenance is dormant—last release was 2024-05-26, with no commits since 2024-09-23, so expect no active bug fixes or feature updates.
License · maintenance · safety
permissive license (permissive) — MIT license (permissive) means you can use, modify, and distribute this plugin freely in commercial and open-source projects with minimal restrictions.
last release 2024-05-26 (810 days) · last repo commit 2024-09-23 · 78 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 149,151 downloads/mo, #11,002 on PyPI
Alternatives
Verify before relying
pip install mkdocs-render-swagger-plugin
Add to mkdocs.yml:
plugins:
- render_swagger
In your markdown file:
!!swagger openapi.json!!
or
!!swagger-http https://example.com/openapi.json!!- Whether the plugin works with recent mkdocs versions given the dormant maintenance status.
- Whether Swagger UI CDN dependencies (unpkg) remain stable and accessible.
- Support for OpenAPI 3.1 or only earlier versions of the specification.
What it is and what it does
mkdocs-render-swagger-plugin is an MkDocs plugin that embeds interactive Swagger UI documentation directly into your MkDocs site by rendering OpenAPI and Swagger JSON schemas. It works by inserting special markup tags into your markdown files—either `!!swagger FILENAME!!` for local JSON files or `!!swagger-http URL!!` for external schemas—which the plugin then converts into fully interactive API documentation at build time.
The plugin uses Swagger UI from a CDN by default but allows you to specify custom JavaScript and CSS assets if needed. It integrates with the MkDocs plugin system and respects the OpenAPI specification standard, making it compatible with schemas generated by tools like FastAPI and Pydantic. However, the project is currently dormant with no active maintenance, so it may not receive updates for compatibility issues with newer mkdocs or OpenAPI versions.
Use it for
- Embed interactive API documentation directly in your project's MkDocs site without maintaining separate documentation portals.
- Display OpenAPI schemas generated by FastAPI or similar frameworks as part of your technical documentation.
- Reference multiple API specifications from different sources (local files or external URLs) within a single documentation site.
- Customize Swagger UI appearance by providing your own CSS and JavaScript assets instead of relying on the CDN.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are building MkDocs documentation and want to embed interactive OpenAPI/Swagger schemas with minimal setup.
The low install friction and permissive license make it straightforward to add. However, be aware that maintenance is dormant—if you encounter issues or need support for newer OpenAPI versions, you may need to fork or patch the plugin yourself. Suitable for stable, self-contained documentation projects.
Install
mkdocs-render-swagger-plugin on PyPI
Before you install
Low friction install as a pure Python wheel with a single runtime dependency on mkdocs. Maintenance is dormant—last release was 2024-05-26, with no commits since 2024-09-23, so expect no active bug fixes or feature updates.
Requires Python 3.8 or later and an existing mkdocs project; OpenAPI files must conform to the OpenAPI specification.
License in practice
MIT license (permissive) means you can use, modify, and distribute this plugin freely in commercial and open-source projects with minimal restrictions.
Quickstart
pip install mkdocs-render-swagger-plugin
Add to mkdocs.yml:
plugins:
- render_swagger
In your markdown file:
!!swagger openapi.json!!
or
!!swagger-http https://example.com/openapi.json!!Verify before relying
- Whether the plugin works with recent mkdocs versions given the dormant maintenance status.
- Whether Swagger UI CDN dependencies (unpkg) remain stable and accessible.
- Support for OpenAPI 3.1 or only earlier versions of the specification.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagemkdocs |
| Maintenance | Dormant 810 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 149,151 / month, #11,002 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3 |
Evidence: mkdocs_render_swagger_plugin-0.1.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs openapi documentation”
- mkdocs-render-swagger-pluginRenders Swagger and OpenAPI schemas as interactive documentation…
- mkdocs-swagger-ui-tagA MkDocs plugin that embeds Swagger UI directly into documentation…
- neoteroi-mkdocsProvides a collection of MkDocs plugins and Markdown extensions for…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also essentials-openapi · mkdocs-swagger-ui-tag · neoteroi-mkdocs · swagger-plugin-for-sphinx · flask-swagger-ui · swagger-ui-py · django-rest-swagger · openapi-codec · scalar-fastapi · aiohttp-swagger