FastAPIのAPIドキュメントで、一部のエンドポイントを権限のあるユーザのみに閲覧を限定する方法

Question

実現したいこと

ここに実現したいことを箇条書きで書いてください。

• 一部のエンドポイントを、権限のあるユーザのみに閲覧を限定する
• もしくは、APIドキュメントに一部のエンドポイントを表示しない

前提

FastAPI+uvicornの構成で、APIを作成しています。
Dependsを用いて、Basic認証によるユーザ認証を設けており、アカウントの権限があるかどうかを判定しています。
/api/docs で表示されるAPIドキュメントについて、ユーザの権限による絞り込みをしたいです。

試したこと

APIドキュメント自体を表示させなくすることはできる。
ただ、権限を絞り込みによって、一部のエンドポイントのみに表示を絞ることができるかは不明。

Answer 1

この回答はGPT-4による自動生成回答です

FastAPIのAPIドキュメントは、Swagger UIを利用して生成されています。権限に応じてエンドポイントを表示・非表示にするためには、カスタムテンプレートを使用してSwagger UIを調整する必要があります。

以下の手順で実装できます。

1. FastAPIアプリケーションでカスタムテンプレートを使用するように設定します。

from fastapi import FastAPI
from fastapi.openapi.docs import get_swagger_ui_html

app = FastAPI()

@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui_html():
    return get_swagger_ui_html(openapi_url="/openapi.json", title="Custom Swagger UI")

1. カスタムテンプレートを作成し、権限に応じてエンドポイントを表示・非表示にするJavaScriptコードを追加します。

<!-- custom_swagger_ui.html -->
{% extends "swagger_ui.html" %}

{% block scripts %}
{{ super() }}
<script>
  // ここに権限に応じてエンドポイントを表示・非表示にするコードを追加
  // 例: 管理者権限がある場合のみ、特定のエンドポイントを表示
  document.addEventListener("DOMContentLoaded", function () {
    const isAdmin = /* 管理者権限の判定 */;
    if (!isAdmin) {
      const endpointElements = document.querySelectorAll('.opblock-summary');
      endpointElements.forEach(function (element) {
        if (element.getAttribute('data-path') === '/admin/endpoint') {
          element.style.display = 'none';
        }
      });
    }
  });
</script>
{% endblock %}

1. FastAPIアプリケーションでカスタムテンプレートを使用するように設定します。

from fastapi import FastAPI
from fastapi.openapi.docs import get_swagger_ui_html
from fastapi.templating import Jinja2Templates

app = FastAPI()
templates = Jinja2Templates(directory="templates")

@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui_html(request: Request):
    return templates.TemplateResponse("custom_swagger_ui.html", {"request": request, "openapi_url": "/openapi.json", "title": "Custom Swagger UI"})

これで、権限に応じてエンドポイントが表示・非表示になるカスタムSwagger UIが実装できます。ただし、権限の判定やエンドポイントの表示・非表示の条件は、実際の要件に応じて調整してください。