OpenAPI / Swagger UI

OpenAPI 仕様からインタラクティブな Swagger UI ページを生成します。

単一 API

{
    "openapi": "swagger.json"
}

api-docs.html に Swagger UI ページが生成されます。

複数 API

{
    "openapi": {
        "api-docs": "swagger/v1.json",
        "admin-api": "swagger/admin.json"
    }
}

各キーが個別の HTML ページになります(例:api-docs.htmladmin-api.html)。

仕様ファイル形式

JSON と YAML の OpenAPI 仕様をサポートしています。仕様ファイルのパスはブックのルートディレクトリからの相対パスです。