FastAPIのドキュメントのカスタマイズ

FastAPIでのドキュメントのカスタマイズ方法を以下に示します。

OpenAPIのカスタマイズ

FastAPIは、OpenAPIのカスタマイズをサポートしています。これにより、APIの仕様を詳細に定義し、ドキュメントを自動生成することができます。以下に、カスタムOpenAPIスキーマを定義する方法を示します。

from fastapi import FastAPI
from fastapi.openapi.utils import get_openapi

app = FastAPI()

def custom_openapi():
    if app.openapi_schema:
        return app.openapi_schema
    openapi_schema = get_openapi(
        title="Custom title",
        version="2.5.0",
        description="This is a very custom OpenAPI schema",
        routes=app.routes,
    )
    app.openapi_schema = openapi_schema
    return app.openapi_schema

app.openapi = custom_openapi

• get_openapi: OpenAPIスキーマをカスタマイズします。これにより、APIのタイトル、バージョン、説明を自由に設定できます。

使用例

このカスタマイズにより、APIドキュメントに独自のブランドや詳細な説明を追加することができます。例えば、APIのバージョンを明示することで、開発者が異なるバージョンのAPIを簡単に識別できるようになります。