Swaggerを導入したい

[funobu]

背景

現状だとフロントエンドとバックエンドがそれぞれ、APIの仕様に沿って独自のモデルを作っている。
しかし、APIのエンドポイントの数が増えていくにつれ、運用のコストは上がっていってしまう。

手動でAPIの仕様に沿って開発することで、以下の問題が発生する可能性が高まる。

• APIのドキュメントを常に最新に更新し、その度に周知しなければ、仕様の変更に気づく手段がない。
• APIの仕様が変わるとしても、その度にフロントエンド←→バックエンド間のプロトコルを統一するのに心理的・肉体的コストがかかってしまう。(ここでヒヤヒヤするのは勿体無い)

目的

• /docsディレクトリにOpenAPIのyamlを配置する。(投稿一覧・投稿詳細まで)
• フロントエンド・バックエンドそれぞれでコードを自動生成する仕組みを作る。