API Document Tools

API って言った時に、API のリクエストを投げる方なのか、API の受け口の方なのかを意識しないと話がよくわからない 私です。

(つらっと雑談を書いた所、思っていたよりもアクセス数があったので他のところで書いた記事を転記します)

そんな私が API Document Tool を調べてみました

■ 参加選手 Swagger http://swagger.io/ RAML http://raml.org/ apiblueprint https://apiblueprint.org/ apiary https://apiary.io/ json-schema http://json-schema.org/

RSpec なら autodoc というのが良いらしいです

■ いろいろ書こうと思って調べたら… 下記の記事が、とてもよくまとまっていたので書かなくてもいいのではないか?と思い始めた http://qiita.com/taizo/items/5a969ace57394a2d5b4a

結論としては、今のところのツールだと全てにおいて簡単に実コードとドキュメントの差分が発生するので メンテが大変 でした。

使い道としては、API のモックサーバー(API をシミュレートしてくれるサーバー)が関の山。 もうちょっと簡単に更新できたり、チェックできるようになったら blog を書きます

■ 参考記事 Document tool 全般について調べた時に参考にさせていただきました http://qiita.com/horimislime/items/32acf0f1be33a269a309 http://qiita.com/taizo/items/5a969ace57394a2d5b4a

autodoc について参考にさせていただきました http://r7kamura.github.io/2013/12/01/autodoc.html