我正在使用Express.js开发一个rest API,我想知道我是否有办法生成API文档,允许用户查看API定义,甚至可能尝试API调用?
答案 0 :(得分:66)
您正在寻找的是一个很好的JavaScript文档生成器。我在这里发现了一个不错的http://apidocjs.com/example/。 这样你就可以像使用op一样使用Express。
Swagger不是文档,而是制作API。因此,您需要学习一个完整的系统才能获得该功能。
我在这里发现了一些我尚未充分研究的东西,但这似乎很有希望: Docco here JSDoc here和an article on Documentor for Node
答案 1 :(得分:32)
Swagger是一个用于自动生成API文档的惊人项目。它包括一个Express模块。
答案 2 :(得分:1)
在使文档和路由声明逻辑保持紧密联系时,我发现此库非常有用:
答案 3 :(得分:0)
如果您在开发时使用 Postman,您可能已经拥有一个包含最相关调用的 Postman 集合。 如果是这种情况,Postman 有一个文档功能 https://learning.postman.com/docs/publishing-your-api/documenting-your-api/