Comment générer de la documentation html API à partir de tests moka BDD?

Question

J'ai travaillé sur un projet avec le framework Spring Boot java où les gars automatisaient la génération de docs API. Chaque fois que vous exécutez des tests de style BDD/Integration, un fichier d'impression api blue a été créé à partir de tests moka. Ensuite, il a généré le modèle générique generate-html-from-api. J'ai aimé cette approche car elle a deux avantages:

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

Quelqu'un at-il essayé et a un exemple de travail pour les projets de noeud? J'ai trouvé api-doc-test plugin, mais sa documentation est limitée. ? Idéalement, je voudrais juste courir:

mocha --recursive 

Ce qui générerait api-doc.html et placer sous test/tmp /. J'ai regardé swagger mais je ne veux vraiment pas spécifier deux fois l'information du point de terminaison et ce serait vraiment génial d'écrire une seule fois dans les tests BDD et d'avoir le double résultat (tests + docs) en même temps.

Answer 1

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

Je travaille sur ce projet, qui permet la génération de documents (actuellement uniquement Blueprint API) à partir de tests BDD, exactement ce dont vous avez besoin.

exemple de code de test:

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 
      }) 
     }) 
    }) 
    }) 
})