2

私は、Spring Boot Java フレームワークを使用して、API ドキュメントの生成を自動化するプロジェクトに取り組みました。BDD/統合スタイルのテストを実行するたびに、mocha テストから作成された API ブルー プリント ファイルがありました。次に、generate-html-from-api ブループリントを実行しました。このアプローチには次の 2 つの利点があるため、気に入りました。

1) API docs are always correct and up-to-date 
2) saves time, because no need to write another documentation file (like apidoc). 

ノードプロジェクトの実際の例を試した人はいますか? api-doc-testプラグインを見つけましたが、そのドキュメントは限られています。? 理想的には、実行したいだけです:

mocha --recursive

これにより、api-doc.html が生成され、test/tmp/ の下に配置されます。

私はswaggerを見てきましたが、エンドポイント情報を2回指定したくありません。BDDテストで1回書くだけで、同時に2つの結果(テスト+ドキュメント)が得られるのは本当に素晴らしいことです。

4

1 に答える 1