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

我正在使用Express.js开发其余的API,我想知道是否有一种方法可以生成允许用户查看API定义甚至可以尝试API调用的API文档?

Nam Nguyen asked 2019-11-18T00:47:07Z
3个解决方案
73 votes

您正在寻找一个好的JavaScript文档生成器。 我在这里[http://apidocjs.com/example/。]找到了一个不错的人。这将允许您按照OP的要求使用Express。

Swagger不是用于生成文档,而是用于制作API。 因此,您将需要学习完整的系统才能获得该功能。

我在这里发现了更多我还没有完全研究过的东西,这些看起来似乎很有希望:
Docco此处JSDoc此处以及有关Documentor for Node的文章

blamb answered 2019-11-18T00:48:51Z
33 votes

Swagger是用于自动生成API文档的出色项目。 它包括一个Express模块。

[http://swagger.io/]

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

Dan Kohn answered 2019-11-18T00:48:08Z
2 votes

我发现该库在使文档和路由声明逻辑保持紧密联系方面非常有用:

[https://www.npmjs.com/package/swagger-jsdoc]

Marcos Pereira answered 2019-11-18T00:49:21Z
translate from https://stackoverflow.com:/questions/18626191/node-js-or-express-js-rest-api-document-generator