Sails.js API 文档

Sails.js API documentation

我想使用 MVC 模式开发 API。我发现 sails 框架很有趣,我想知道是否可以配置 swagger 或类似 sails 的东西来生成我的 API 的文档(例如 swagger-express for express)。

谢谢!

此功能正在进行中。如果你愿意帮忙,我们都可以在这里合作:https://github.com/balderdashy/sails/issues/1094

更新(2015 年 8 月):

查看这个提供原生 Swagger 集成的 Sails Hook。它编译 Sails 中所有绑定的路由,并生成一个 Swagger 2.0 文档:https://github.com/tjwebb/sails-swagger

以下是我使文档与 sails.js 一起工作的方法:您可以在此处下载 swagger-ui:https://github.com/swagger-api/swagger-ui 或通过 npm(npm install swagger-ui).

然后在您的 sails 项目的资产文件夹中,创建一个指向 swagger 文件夹的文件夹(例如 "docs",这样您就可以通过 your_url 访问您的文档:port/docs)