OpenAPIについて
概要
- RESTful APIのための仕様(Specification)である
- 以前はSwaggerと呼ばれていた
- FastAPIの
/docs
や/redoc
で表示されるドキュメントはOpenAPIで生成されている
特徴
- 標準化されたドキュメント
- クライアントとサーバーのコード生成
- 仕様書からコードを生成することができる
- インタラクティブなドキュメント
- 仕様書から直接APIを試すことができる
- APIのテストと検証
- APIの動作をテストし、仕様に準拠しているかどうかを検証することができる