mocha BDDテストからAPI htmlドキュメントを生成する方法は？

Question

私は、自動化されたAPIドキュメント生成を行うSpringのJavaフレームワークを使用してプロジェクトを作成しました。 BDD /統合スタイルテストを実行するたびに、mochaテストから作成されたapiの青いプリントファイルがありました。その後、generate-html-from-apiの青写真を実行しました。

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

は、誰もが試みたとノードプロジェクトの例を働いた：それは2つの利点があるように私はこのアプローチを気に入っ？私はapi-doc-testプラグインを見つけましたが、そのドキュメントは限られています。 ？理想的には、私は実行したいと思います：

テストの/ tmp /の下にAPI-doc.htmlと場所を生成する

mocha --recursive 

。

ぼんやりとしたものを見ましたが、実際にエンドポイント情報を2回指定したくないので、BDDテストで1回書いてみて、同時に2つの結果（テスト+ドキュメント）を作成するのは本当に素晴らしいと思います。

Answer 1

https://github.com/stackia/test2doc.js

私はあなたが必要なだけのまさに、BDD試験からドキュメント（現在はAPIの設計図）を生成可能にする、このプロジェクトに取り組んでいます。

テストコードの例：私たちは、から生成されるAPIの青写真を作成していない

const doc = require('test2doc') 
const request = require('supertest') // We use supertest as the HTTP request library 
require('should') // and use should as the assertion library 

// For Koa, you should exports app.listen() or app.callback() in your app entry 
const app = require('./my-express-app.js') 

after(function() { 
    doc.emit('api-documentation.apib') 
}) 

doc.group('Products').is(doc => { 
    describe('#Products', function() { 
    doc.action('Get all products').is(doc => { 
     it('should get all products', function() { 
     // Write specs towards your API endpoint as you would normally do 
     // Just decorate with some utility methods 
     return request(app) 
      .get(doc.get('/products')) 
      .query(doc.query({ 
      minPrice: doc.val(10, 'Only products of which price >= this value should be returned') 
      })) 
      .expect(200) 
      .then(res => { 
      body = doc.resBody(res.body) 
      body.desc('List of all products') 
       .should.not.be.empty() 
      body[0].should.have.properties('id', 'name', 'price') 
      body[0].price.desc('Price of this product').should.be.a.Number 
      }) 
     }) 
    }) 
    }) 
})