README.md

MkDocs Swagger UI Tag

A MkDocs plugin supports adding Swagger UI to the page.

Live demo with Material for MkDocs.

Features

1. OpenAPI Specification file from online over URL or static file in docs
2. All dependencies are using static files handled by the plugin not from CDN, especially suitable for those documents been deployed in the intranet
3. Multiple Swagger UI on the same page
4. Synchronized dark mode with Material for MkDocs
5. Configure Swagger UI configuration through plugin options and tag attributes
6. Support multiple OAS in a single Swagger UI with a top bar selector
7. Support Swagger UI initOAuth method

Dependency

1. Python Package
   1. beautifulsoup4>=4.11.1
2. Swagger UI dist javascript file and CSS file
   1. swagger-ui-dist==5.17.14

Usage

1. Install the plugin from PyPI

   pip install mkdocs-swagger-ui-tag

2. Add swagger-ui-tag plugin to your mkdocs.yml plugins sections:

   plugins:
      - swagger-ui-tag

3. Add swagger-ui tag in markdown to include Swagger UI

   <swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>

   

4. You may customize the plugin by passing options in mkdocs.yml, check more details on options:

   plugins:
      - swagger-ui-tag:
           background: White
           docExpansion: none
           filter: ""
           syntaxHighlightTheme: monokai
           tryItOutEnabled: ['get', 'post']

   Options	Type	Description
   background	String	Default: "". Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or "Gainsboro" or "" for nothing.
   docExpansion	String	Default: "list". Controls the default expansion setting for the operations and tags. It can be "list" (expands only the tags), "full" (expands the tags and operations) or "none" (expands nothing).
   filter	String or Boolean	Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.
   syntaxHighlightTheme	String	Default: "agate". Highlight.js syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night"
   tryItOutEnabled	Boolean	Default: False. This setting determines the default editability of the "Try it out" section, including parameters or body.
   oauth2RedirectUrl	String	Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html". OAuth redirect URL.
   supportedSubmitMethods	Array	Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display.
   validatorUrl	String	Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it "none" to disable validation.

How it works

1. Copy the Swagger UI script file into site/assets/javascripts/ directory, the CSS file into site/assets/stylesheets/ directory, and the default Oauth2 redirect html into site/assets/swagger-ui/ directory
2. Search all swagger-ui tags, then convert them to an iframe tag and generate the iframe target HTML with the given OpenAPI Specification src path and options

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Reference

1. Amoenus Swagger Dark Theme: source of dark mode css