OpenAPI仕様書(Swagger)を書く時に参考にできるサイト

そもそもopenAPI仕様書ってこんなものってのを理解する

• OpenAPI (Swagger) 超入門 - Qiita

Swagger公式

サンプル見たりするのに使うかな。
正直見にくい。

• OpenAPI Guide

GitHubのドキュメント

これが一番使うかな。
yamlやjsonは階層構造になってて、どんどん深掘りしていける。
components配下のparametersオブジェクトで指定できる項目は？
inに指定できるコードは？
など検索できるのが良い。

• OpenAPI Specification

HTTPステータスコード一覧

APIですから、ステータスコードに意味をしっかり持たせたいですよね。

• HTTP レスポンスステータスコード

個人的に参考にしたサイト

components配下の書き方、$refでの汎用性の持たせ方など、大変参考になりました。

• OpenAPI Specification 3.0.3を使ったいい感じのCRUD APIのサンプルを作る

SwaggerとOpenAPI

openapi: 3.0.3
swagger: 2.0
どっちを書くかで思ったよりフォーマットが違ってくる。
なんか最近はopenapiにしといた方が良さげなんかなあ。