Logo
📃

APIのドキュメントを書く

2021-04-10

APIの開発を始めた

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

APIのドキュメントを書く

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

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

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

執筆の進め方

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


yukyu
Twitter

© 2021, yukyu

一部の絵文字にはTweomjiを利用しています