sails.js - 扬 sails 起航 JS

Question

关于如何集成 的任何想法 Swagger , swagger-ui 和 sails js 项目？

我在哪里可以找到有关它的信息，或者有关评论用sails 生成的api 的另一种方式？

谢谢!

Answer 1

一个多星期前，我正在寻找解决方案，但我发现信息有点分散。以下是我将 swagger 和 swagger-ui 与我的sails 0.11.x 项目集成的方法。

1.安装sails-swagger

npm install --save sails-swagger

这提供了一个钩子(Hook)，可以动态生成 swagger 文档。不幸的是，它只与sails 0.12.x(在本文发布时是一个rc)兼容。因此，要使其与 0.11.x 一起使用，您必须扩展 SwaggerController 并覆盖 config/installedHooks.js ( issue reference ) 中的钩子(Hook)名称

api/ Controller /SwaggerController.js

'use strict';

/**
 * This is a temp fix while one sails 11.x
 * @see https://github.com/tjwebb/sails-swagger/issues/3
 */
var _ = require('lodash');
var _super = require('sails-swagger/dist/api/controllers/SwaggerController');

_.merge(exports, _super);
_.merge(exports, {
  _config: {
    actions: false,
    shortcuts: false,
    rest: false
  }
});

配置/installedHooks.js

'use strict';

/**
 * This is a temp fix while one sails 11.x
 * @see https://github.com/tjwebb/sails-swagger/issues/3
 */
module.exports.installedHooks = {
  'sails-swagger': {
    'name': 'swagger'
  }
};

最后，根据文档提供钩子(Hook)的配置

配置/swagger.js

'use strict';

module.exports.swagger = {
  /**
   * require() the package.json file for your Sails app.
   */
  pkg: require('../package')
};

2.安装swagger-ui

npm install --save-dev swagger-ui@2

有几种方法可以处理这个问题。您可以使用 vanilla swagger-ui 模块并在其 dist 中添加所有内容到您的构建过程。但是我选择将它复制到我的项目中，因为我打算稍微自定义界面。

mkdir assets/docs
cp -r node_modules/swagger-ui/dist/* assets/docs/

NOTE (3/26/2017): swagger-ui v3.x has been re-built using React (yay!), but easily integrating it with sails is not obvious at the moment.

3.配置swagger-ui

最后，您需要将 swagger-ui 指向您动态生成的 swagger 文档。 swagger 文档的默认路由是 /swagger/doc ，因此您可以在 swagger-ui 配置中显式设置它。

Assets /文档/index.html

<script type="text/javascript">
    $(function () {
      var url = '/swagger/doc';

      // Pre load translate...
      if(window.SwaggerTranslator) {
        window.SwaggerTranslator.translate();
      }
      window.swaggerUi = new SwaggerUi({
        url: url,
        // ...removed for brevity
</script>

4. 利润

现在您可以导航到 /docs在您的浏览器中查看您漂亮的文档。