MkDocs で OpenAPI ドキュメントを表示する¶
MkDocs で OpenAPI ドキュメントを表示するには plugin を使う。 調べたところ 4 つの plugin で OpenAPI ドキュメントを表示できることがわかった。
表示形式は次の表のとおり。Swagger UI を細かく設定したい場合は、mkdocs-swagger-ui-tag の設定オプションを確認するとよい。
| Plugin | Swagger UI | Table | ReDoc | 設定項目 |
|---|---|---|---|---|
| mkdocs-render-swagger-plugin | o | x | x | 基本設定 |
| mkdocs-swagger-ui-tag | o | x | x | Swagger UI の詳細設定 |
| neoteroi-mkdocs | x | o | x | - |
| mkdocs-redoc-tag | x | x | o | - |