apiDoc

 

apiDocは、ソースコードの中にアノテーションを記述することで、APIドキュメントを生成するツールです。Docs as Codeを実現できます。

apiDocのWebサイト

特徴

apiDocの特徴は以下の通りです。

  • ソースコードの中にAPI仕様を記述
  • アノテーションに従ってAPIドキュメントを生成

apiDoc自体はNode.jsで作られていますが、対応言語はさまざまです。

  • Java
  • JavaScript
  • PHP
  • TypeScript
  • CoffeeScript
  • Elixir
  • Erlang
  • Perl
  • Python
  • Ruby
  • Lua
  • Go言語

この他、DocStyleをサポートしたソースコードであれば利用できます。

料金

apiDocはオープンソース・ソフトウェアなので、無料で利用できます。

URL

apiDoc - Inline Documentation for RESTful web APIs