Swagger UI を使用して FastAPI で API ドキュメントを表示する方法

Swagger UI を使用して FastAPI で API ドキュメントを表示する方法

はじめに:
現代の Web 開発では、API は不可欠な部分です。開発とメンテナンスを容易にするために、他の開発者が API を理解して使用できるように、フレンドリーで使いやすい API ドキュメントを提供する必要があります。 Swagger は、API の詳細を視覚的に表示できる対話型 UI インターフェイスを提供する、一般的な API ドキュメント形式およびツールです。この記事では、FastAPI で Swagger UI を使用して API ドキュメントを表示する方法を説明します。

1. 依存関係のインストール
   まず、FastAPI と関連する依存関係をインストールする必要があります。次のコマンドを使用してインストールできます:

   pip install fastapi[all]

   これにより、FastAPI とそれに必要なすべての依存関係 (Swagger UI を含む) がインストールされます。

2. FastAPI アプリケーションの作成
   次に、FastAPI アプリケーションを作成します。新しい Python ファイルに、次のコードを記述します。

   from fastapi import FastAPI
   
   app = FastAPI()
   
   @app.get("/")
   async def root():
    return {"message": "Hello World"}

   この単純なアプリケーションは、単純な「Hello World」メッセージを返すルート ルートを定義します。

3. Swagger UI の追加
   Swagger UI をアプリケーションに追加するには、関連する FastAPI コンポーネントをインポートする必要があります。次のコードをアプリ ファイルに追加します。

   from fastapi import FastAPI
   from fastapi.openapi.utils import get_openapi
   from fastapi.openapi.docs import get_swagger_ui_html
   
   app = FastAPI()
   
   @app.get("/")
   async def root():
    return {"message": "Hello World"}
   
   def custom_swagger_ui_html(*, request):
    openapi_url = app.openapi_url
    swagger_url = openapi_url.replace("/openapi.json", "/swagger")
    return get_swagger_ui_html(
        openapi_url=openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=swagger_url + "/oauth2-redirect.html",
        swagger_js_url="/static/swagger-ui-bundle.js",
        swagger_css_url="/static/swagger-ui.css",
    )
   
   app.openapi = get_openapi(title="My API")
   
   @app.get("/swagger", include_in_schema=False)
   async def swagger_ui_html(request: Request):
    return custom_swagger_ui_html(request=request)
   
   app.mount("/static", StaticFiles(directory="static"), name="static")

   コードでは、custom_swagger_ui_html というカスタム関数を作成します。この関数は、FastAPI によって提供される get_swagger_ui_html 関数を使用して、Swagger UI の HTML ページを生成します。また、Swagger UI の静的ファイルへの URL とパスもいくつか定義しました。

4. アプリケーションの実行
   これで、アプリケーションを実行する準備が整いました。ターミナルで、次のコマンドを使用してアプリケーションを開始します。

   uvicorn main:app --reload

   これにより、アプリケーションが開始され、デフォルトのアドレス http://localhost:8000 でローカルに実行されます。

5. API ドキュメントの表示
   ブラウザで http://localhost:8000/swagger を開くと、対話型の Swagger UI インターフェイスが表示されます。ルーティング、リクエストとレスポンスのモデルなど、API の詳細が表示されます。

結論:
FastAPI と Swagger UI を使用すると、API ドキュメントを簡単に表示および参照できます。これにより、開発者は API を理解し、使用することが容易になります。この記事が、Swagger UI を使用して FastAPI で API ドキュメントを表示するのに役立つことを願っています。

上記は、Swagger UI を使用して FastAPI で API ドキュメントを表示する方法に関するガイドです。この記事がお役に立てば幸いです。読んでくれてありがとう！

以上がSwagger UI を使用して FastAPI で API ドキュメントを表示する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。