📚

FastAPIのOpenAPIスキーマを取得する

に公開

執筆日

2025/9/8

この記事で書くこと

この記事では、FastAPI で自動生成される OpenAPI スキーマを

  • curl コマンドで取得する方法
  • ReDoc 画面からエクスポートする方法
    の2通り紹介します。

FastAPIでOpenAPIスキーマを出力する2つの方法

手順①:curl コマンドで取得する

FastAPI アプリを立ち上げると、/openapi.json にスキーマが出力されます。
これをコマンドラインから curl を使って取得し、ファイル保存できます。

curl http://localhost:8000/openapi.json > openapi.json

これでカレントディレクトリに openapi.json が生成されます。

手順②:ReDoc の画面からエクスポートする

FastAPI はデフォルトで以下のドキュメント画面を提供します。

ReDoc では、右上の 「Export」 ボタンから OpenAPI スキーマをダウンロードできます。

  1. ブラウザで http://localhost:8000/redoc を開く

  2. ページ右上にある「Export」ボタンをクリック

  3. JSON ファイルとして保存される

ヘッドウォータース

Discussion