はじめに
今回は、FastAPI によって自動生成される Swagger UI（http://localhost:8000/docs）について簡単にまとめておきます。
開発中のAPIを素早く確認・テストできるツールとして非常に便利なため、特にバックエンドとフロントエンドの連携を進める上でとても便利だと思いました。
書こうと思ったきっかけ
受講しているITスクールのハッカソンの開発の一環で、FastAPIを使ったバックエンドの開発に取り組んでおり、エンドポイントの確認や挙動チェックを行う際に http://localhost:8000/docs によるSwagger UIの存在がとても役立ちました。
ログインやユーザー登録、チャット送信などのエンドポイントを手早く検証する方法を備忘録として残しておくためです。
内容
Swagger UIとは？
FastAPIでは、アプリを起動すると自動的に /docs にSwagger UIが展開されます。
この画面では以下が可能です：
- 全エンドポイントの一覧表示
- パラメータやリクエスト形式の自動ドキュメント化
- リクエストの送信とレスポンスの即時確認
よく使う操作
-
POST /api/loginに対して、email と password を入力しトークン取得を確認 -
POST /api/registerや/api/sessionsなどのエンドポイントで、JSONを試しに送信 -
AuthorizationヘッダーにBearerトークンをセットして、認証が必要なAPIの確認
実際の画面
Swaggerの便利な点
- OpenAPIに準拠したドキュメント形式で、他の開発者と仕様を共有しやすい
- テストツールを用意せず、すぐにブラウザ上で試せる
まとめ
FastAPIとSwagger UIの組み合わせは、バックエンド開発を効率化する上で感動しました。特にハッカソンやチーム開発では、フロントエンドと仕様のすり合わせを行う際の可視化ツールとしても良いと思いました！
今後もAPIを追加・修正していく中で、Swaggerを活用しながら品質とスピードのバランスをとって開発を進めていきます...！