OpenAPIについて

OpenAPIとは
何ができるか/何が良いのか

Transcript

1. OpenAPI Specification について
2. OpenAPI Specification とは 概念 API 仕様のフォーマット どこで( エンドポイント) どんなメソッドで(HTTP メソッド) どんなデータを送るのか( リクエストデータ) どんなデータが返ってくるのか( レスポンスデータ) 実体 API 仕様定義ファイル ⇨YAML または JSON ファイル 具体的な書き方は調べてください( 難しくないです) Swagger Editor などを使うと、リアルタイムプレビューしながら書けるそう 　⇨直でyaml を書くのは結構辛い、 、 、
3. 何ができるのか/ 何が良いのか 1. 統一されたAPI 仕様書の作成 ⇨フロントとバックでの認識齟齬が起こりにくい 2. API 定義書を他ツールと連携させることで開発効率UP できること 連携ツール 備考 自動でAPI テストケ ース作成 Postman Github Action などと組み合わせることで、定義書更新⇨テストケース更新の自 動化も可能 モックサーバーの自 動構築 Prism コード生成 Swagger Codegen Swagger Codegen では、SDK( 例 リクエスト/ レスポンスのユーザー定義型) や バック骨組みモックの生成が可能 ドキュメント生成 Redoc, Swagger UI SwaggerUI はVSCode 拡張機能あり