Node.js或Express.js REST API文档生成器

Question

我正在使用Express.js开发restAPI,我想知道是否有办法生成API文档,允许用户查看API定义,甚至可能尝试API调用？

Answer 1

您正在寻找的是一个很好的JavaScript文档生成器.我在这里找到了一个不错的http://apidocjs.com/example/.这样你就可以像使用op一样使用Express.

Swagger不是用于制作API的文档.因此,您需要学习一个完整的系统才能获得该功能.

我发现一对夫妇更在这里,我还没有完全看着然而这似乎有希望:
Docco 这里 JSDoc 这里,并为节点上的文件处理器的文章

Answer 2

Swagger是一个用于自动生成API文档的惊人项目.它包括一个Express模块​​.

http://swagger.io/

https://github.com/wordnik/swagger-node-express