開発効率を上げるWebAPIドキュメントの書き方 - Qiita個人的にAPIサーバーを書くことが多く、APIクライアントの担当エンジニアと作業をする上で、効率よく作業できるAPIドキュメントの書き方を探していました。 今のところAPI Blueprintというフォーマットがしっくり来ていて、実際に私達が運用しているやり方と合わせて紹介したいと思います。 やりたいこと 当初APIのドキュメントに困っていたこと、やりたかったことは以下の通りです。 場所と時間に制約されず、API設計を非同期でレビューしたい バージョン管理したい 簡潔に書きたい リッチテキストは嫌だ！ API Blueprintとは ざっくりいうと、MarkdownでAPIドキュメントを書くためのフォーマットのことです。 また、オープンソースの周辺ツールが非常に強力で、API Blueprintで書かれているドキュメントを読み込んでAPIのモックサーバーを建てるものや、テストケースを作成す
