現場で必要になるswaggerの知識 - Qiita

前回は「今日から始めるswagger入門」という最低限書けるようになっておいた方が良い物をこちらの記事で解説させてもらいました 今回は、筆者が4〜5年ほど現場で見てきたswaggerを元に、現場で必要になるswaggerの知識をまとめましたので、ぜひご覧になっていただけると嬉しいです！ タグ付け pathsに書かれている各APIendpointをタグ付けしてグルーピングする目的で使用されます 現場では大量のAPIendpointを設計していくこととなるので、多くなってくると大変見辛くなってきます それをグルーピングすることにより見やすくしようということです openapi: 3.0.3 info: title: test-api version: 0.0.1 # ここから tags: - name: user description: ユーザー情報 # ここまで paths: /users

[BOOOOOOOON]

単なるAPI Specを表すドキュメントってだけでなくOpenAPI Generatorを使うことでソースコードが自動生成されるので実装とSpecが常に同期取れてる状態になるのがいいのだ

[akymrk]

“allOf：スキーマ同士を結合するイメージです複数のスキーマ同士を結合したり、例のようなpropertiesも結合できます（無名のスキーマととらえるとイメージしやすい） $ref：他の定義を参照する際に使用します”

[kagehiens]

滅多に使う機会無いけど要ることはある

[otihateten3510]

いいね