Sails.js API 文档答案

【问题标题】：Sails.js API documentationSails.js API 文档
【发布时间】：2015-05-04 06:13:41
【问题描述】：

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

谢谢！

【问题讨论】：

你可以尝试自己做，大摇大摆只需要和端点从哪里读取有关服务器端点的所有信息，或者可能在规范github.com/swagger-api/swagger-spec
我想我必须尝试这样做，看起来还没有人研究过解决方案。
我们正在努力。
sails-hook-swagger-generator 库应该有助于在很少或没有配置的情况下执行该操作github.com/theo4u/sails-hook-swagger-generator

【解决方案1】：

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

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

【讨论】：

您在获取有关如何使用sails express 应用程序实现此类功能的信息方面是否取得了任何进展？
当我使用sails-swagger时它说：-错误：引导函数在其回调被调用后抛出错误 :: Ty peError: Cannot set property 'doc' of undefined Do you have any documentation about如何实现

【解决方案2】：

这是我为使我的文档使用sails.js 所做的：您可以在此处下载swagger-ui：https://github.com/swagger-api/swagger-ui 或通过npm (npm install swagger-ui)。

然后在您的sails 项目的assets 文件夹中，创建一个指向swagger 文件夹的文件夹（例如“docs”，这样您就可以通过your_url:port/docs 访问您的文档）

【讨论】：