Sails.js API文档

kra*_*kig 7 model-view-controller node.js swagger sails.js

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

谢谢!

Tra*_*ebb 5

此功能正在进行中.如果你想提供帮助,我们可以在这里进行合作:https://github.com/balderdashy/sails/issues/1094

更新(2015年8月):

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


kra*_*kig 2

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

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