Docbox - Web APIドキュメントジェネレータ
APIを使ってもらう上で大事なのがドキュメントです。分かりやすいドキュメントがあるかどうかで開発者としても使いたいと思うかどうかが決まってきます。 そんなドキュメントジェネレータとして使ってみて欲しいのがDocboxです。 Docboxの使い方 Docboxの生成したドキュメントの例です。3ペインになっていて、左側からメニュー、コンテンツそしてテスト実行するためのコードとなっています。 右側は言語を変更するとサンプルコードも変わるようになっています。 DocboxはAPIの構造理解と、そのテスト実行するためのコードを並べて確認できるようになっています。ドキュメントは○○で書く仕組みになっています。DocboxはAPIドキュメントとしてはかなりリッチな表示、コンテンツが実現できるでしょう。 Docboxはnode/JavaScript製のオープンソース・ソフトウェア（MIT License）
GitHub - tmcw/docbox: REST API documentation generator
docbox Docbox is an open source REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown. Demo documentation Docbox is a JavaScript application written with React. The cor
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
