我正在使用 Express.js 开发一个 restAPI，我想知道是否有一种方法可以让我生成允许用户查看 API 定义甚至可能尝试 API 调用的 API 文档？
问问题
61034 次
4 回答
101
您正在寻找的是一个好的 JavaScript 文档生成器。我在这里找到了一个不错的http://apidocjs.com/example/。这将允许您按照 OP 的要求使用 Express。
Swagger 不是用于生成文档，而是用于制作API。因此，您将需要学习一个完整的系统才能获得该功能。
我在这里发现了一些我还没有完全研究过的看起来很有希望的东西：
Docco here JSDoc here和一篇关于 Documentor for Node 的文章
于 2015-10-20T04:18:12.950 回答
41
Swagger 是一个用于自动生成 API 文档的了不起的项目。它包括一个 Express 模块。
于 2013-09-05T01:15:22.347 回答
2
我发现这个库在保持文档和路由声明逻辑紧密结合时非常有用：
于 2019-01-05T20:22:39.447 回答
0
如果您在开发时使用 Postman，您可能已经拥有一个包含最相关调用的 Postman 集合。如果是这种情况，邮递员有一个文档功能https://learning.postman.com/docs/publishing-your-api/documenting-your-api/
于 2021-05-16T09:07:42.807 回答