ITエンジニア/デザイナ向けにオープンソースを毎日紹介

APIを使ってもらう上で大事なのがドキュメントです。分かりやすいドキュメントがあるかどうかで開発者としても使いたいと思うかどうかが決まってきます。

そんなドキュメントジェネレータとして使ってみて欲しいのがDocboxです。

Docboxの使い方

Docboxの生成したドキュメントの例です。3ペインになっていて、左側からメニュー、コンテンツそしてテスト実行するためのコードとなっています。

右側は言語を変更するとサンプルコードも変わるようになっています。

DocboxはAPIの構造理解と、そのテスト実行するためのコードを並べて確認できるようになっています。ドキュメントは○○で書く仕組みになっています。DocboxはAPIドキュメントとしてはかなりリッチな表示、コンテンツが実現できるでしょう。

Docboxはnode/JavaScript製のオープンソース・ソフトウェア(MIT License)です。

Docbox

mapbox/docbox: REST API documentation generator

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2