【自分用】 OpenAPI(Swagger形式)の簡易的なメモ
最近、バックエンドはRails(API)、フロントはReact, Vue などといった開発がデファクトスタンダードになってきた。
実際に今個人で開発しているものも、 まさにこの手法で開発を進めている。
そんな中、今関わっている案件で OpenAPI(Swagger形式)をもとにスタブを開発することになったので、メモとして残しておく。
※ PHP / Laravel でのスタブ作成
OpenAPI(Swagger形式)とは？
OpenAPI(Swagger形式)というツールでRESTfulなAPIの定義方法が標準化されたものである。
周辺ツール
- Swagger Editor
- Swagger UI
- OpenAPI Generator
書き方
基本的に、 yamlだが、 jsonでも書ける
例)
Swaggerとかよく知らんってときに、↑みたいな仕様書どばっと渡されて スタブ作っておいて... って やばい汗.... って感じだったが。
調べた結果先ほどツールで紹介した、Swagger Editor (https://editor.swagger.io/) に、 yamlファイルをドバッと流し込めばかなり見やすく リクエストやレスポンスも確認できて
スタブ作りに役に立ちそうだった。
こんな感じ
おわり。