分かりやすいドキュメントを。APIドキュメントジェネレータまとめ(2)

前半はこちら。

rjha/restdoc

PHP製のスクリプトでYAMLフォーマットの定義からドキュメントを生成します。スクリプト言語なのでYAMLを更新するだけでいつでも最新のドキュメントが読めるのは良さそうです。

MireDot | REST API Documentation Generator for Java

Javaで作られたシステム用のAPIドキュメントジェネレータです。JavaDocのように簡単に、とあるのでJavaDocを書かれた経験がある方であればすぐに使いこなせるでしょう。

ehearty/Swadl

RESTful APIにおけるWSDLとも言えるWADLをベースにドキュメントを生成するソフトウェアです。

Apiary - Home

APIの仕様を定義するとドキュメントの生成はもちろん、APIモックの生成、コードサンプル、テスト自動化など複合的にサービスを提供しています。

tombenke/rest-tool

nodeで作られたライブラリで、JSONフォーマットで定義した内容を読み取ってドキュメントを生成します。

malachheb/calamum

JSON/YAMLで書かれたファイルからドキュメントを生成します。


APIドキュメントを適切に整備していくためにはツールの使いやすさはもちろんのこと、ベースになる記法やそのルールの分かりやすさも重要になってくるでしょう。

ぜひこれらのツールを参考に、他の開発者にとって分かりやすいドキュメントを書いてください。

© NTT Communications Corporation All Rights Reserved.