コンテンツにスキップ

MkDocs で OpenAPI ドキュメントを表示する

MkDocs で OpenAPI ドキュメントを表示するには plugin を使う。 調べたところ 4 つの plugin で OpenAPI ドキュメントを表示できることがわかった。

  1. mkdocs-render-swagger-plugin
  2. mkdocs-swagger-ui-tag
  3. neoteroi-mkdocs
  4. mkdocs-redoc-tag

1 と 2 は Swagger UI で表示されるが 3 は table 形式、4 は ReDoc 形式で表示される。 1 と比べて 2 は設定できる項目が多いのでその辺りで使い分けると良い。

Plugin Swagger UI Table ReDoc 設定項目
mkdocs-render-swagger-plugin o x x 多い
mkdocs-swagger-ui-tag o x x 少ない
neoteroi-mkdocs x o x -
mkdocs-redoc-tag x x o -