Registry / web-framework / mkdocs-render-swagger-plugin

mkdocs-render-swagger-plugin

library0.1.2pypypi✓ verified 84d ago

MkDocs plugin for rendering Swagger & OpenAPI specification files in documentation pages. Current version 0.1.2, supporting Swagger-UI v5. Released on PyPI, actively maintained.

web-framework

pip install mkdocs-render-swagger-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · MKDOCS-RENDER-SWAG

mkdocs-render-swagger-plugin

web-frameworkpythonv0.1.2

Install

2.9s avg

Import

—

Disk

32MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.1.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 33MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.9s · import 0.000s · 34MB

32MB installed

● package 32MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SwaggerPlugin

✓ from render_swagger import SwaggerPlugin

✗ from mkdocs_render_swagger_plugin import SwaggerUI

Add the plugin to mkdocs.yml, then use the :swagger: tag in markdown files to embed an OpenAPI spec.

# In mkdocs.yml: # plugins: # - render_swagger # In a markdown page: # :swagger: path/to/openapi.yaml # Example usage with env variable: # :swagger: https://petstore.swagger.io/v2/swagger.json

mkdocs --version

Debug

Known issues

breakingVersion 0.1.0 bumped Swagger-UI to major version 5, which may break customizations relying on internal CSS or JS selectors.

fix

Review Swagger-UI 5 migration guide; update any custom assets or styling.

affects: >=0.1.0

gotchaThe plugin uses the package name 'mkdocs-render-swagger-plugin' but the entry point in mkdocs.yml is 'render_swagger' (with underscores).

fix

In mkdocs.yml, use 'plugins: [render_swagger]' or the full import path as configured.

affects: all

Upgrade

Version history

0.1.2latest on PyPI · released May 26, 2024

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/bharel/mkdocs-render-swagger-plugin ↗

packagehttps://pypi.org/project/mkdocs-render-swagger-plugin/ ↗