Node.js或Express.js REST API文档生成器[已关闭]

smdncfj3  于 2023-04-05  发布在  Node.js
关注(0)|答案(5)|浏览(149)

**已关闭。**此问题正在寻求有关书籍、工具、软件库等的建议。它不符合Stack Overflow guidelines。当前不接受答案。

我们不允许问题寻求有关书籍、工具、软件库等的推荐。你可以编辑问题,以便可以使用事实和引用来回答问题。
5天前关闭。
社区在5天前审查了是否重新讨论此问题,并将其关闭:
原始关闭原因未解决
Improve this question
我正在使用Express.js开发一个restAPI,我想知道是否有一种方法可以生成API文档,允许用户查看API定义,甚至可以尝试API调用?

x8diyxa7

x8diyxa71#

你正在寻找的是一个很好的JavaScript文档生成器。我在这里找到了一个不错的http://apidocjs.com/example/。这将允许你按照OP的要求使用Express。
Swagger不是用来生成文档的,它是用来制作API的。所以你需要学习一个完整的系统来获得这个功能。
我在这里发现了一些我还没有完全研究过的,看起来很有希望的东西:
Docco here JSDoc herean article on Documentor for Node

vsaztqbk

vsaztqbk2#

Swagger是一个自动生成API文档的惊人项目。它包括一个Express模块。
http://swagger.io/
https://github.com/wordnik/swagger-node-express

1l5u6lss

1l5u6lss3#

我发现这个库在保持文档和路由声明逻辑紧密联系方面非常有用:
https://www.npmjs.com/package/swagger-jsdoc

nwlls2ji

nwlls2ji4#

如果您在开发时使用Postman,您可能已经有了一个包含最相关调用的Postman集合。

5uzkadbs

5uzkadbs5#

您可以使用一些支持TS文件的库。
如果你使用Js,那么你可以使用我的库。
下面是一个例子:https://youtu.be/XG5o8xXZtmM
相关链接:

相关问题