SUZURIでオリジナルグッズ販売中

📃

APIのドキュメントを書く

この記事はblog.yukyu.netで公開した記事を転載したものです

API の開発を始めた

BUMESHI!!という WEB アプリケーションを公開していますが、フロントエンド、バックエンドどちらとも Ruby で書かれています。いろいろあって、BUMESHI!!を刷新しようとしています。今後、モバイルアプリケーションの開発を見据え BUMESHI!!を Rails API+React で作り直すことにしました。
そこで、API のドキュメントを書く必要がでてきました。

API のドキュメントを書く

API の仕様についてドキュメントには、Notion というドキュメントツールを使用し、まとめていきます。

API ドキュメントを書くのに参考にしたサイト

上記の二つのサイトを参考にドキュメントを書いています。自分の API との出会いは SUZURI API です。なので SUZURI API のドキュメントを参考に記述しています。

執筆の進め方

基本的に API を実装したら、その実装した部分のドキュメントを書いていくことにしています。
APIドキュメントに一部
Eateryの項目の一部