Swagger工具生产环境构建Node.js

Question

我们在我们的Node.js应用程序中实现了Swagger。目前，我们使用Webpack创建了生产构建并删除了控制器和服务文件。 bin/www.js

const YAML = require('yamljs');
const swaggerTools = require('swagger-tools');
const swaggerDoc = YAML.safeLoad('./swagger.yaml');

// swaggerRouter configuration
const swaggerOptions = {
  controllers: path.join(__dirname, '../public/javascripts/controllers'),
  useStubs: true, // Conditionally turn on stubs (mock mode)
};


// Initialize the Swagger middleware
swaggerTools.initializeMiddleware(swaggerDoc, (middleware) => {
  // Interpret Swagger resources and attach metadata to request - must be first in swagger-tools middleware chain
  app.use(middleware.swaggerMetadata());

  // validate the security using JWT token
  app.use(middleware.swaggerSecurity({
      Bearer: auth.verifyToken
  }));
  // Validate Swagger requests
  app.use(middleware.swaggerValidator({
    validateResponse: true
  }));

  // Route validated requests to appropriate controller
  app.use(middleware.swaggerRouter(swaggerOptions));

  // Serve the Swagger documents and Swagger UI
  app.use(middleware.swaggerUi());

});

如果我们在生产环境中执行相同操作，并且Swagger中间件期望解析相同的路径，则在构建后删除public文件夹。

Webpack代码

const path = require('path');
const nodeExternals = require('webpack-node-externals');

module.exports = {
  entry: {
    server: './bin/www',
  },
  output: {
    path: path.join(__dirname, 'dist'),
    publicPath: '/',
    filename: 'server.build.js',
  },
  target: 'node',
  node: {
    // Need this when working with express, otherwise the build fails
    __dirname: false, // if you don't put this is, __dirname
    __filename: false, // and __filename return blank or /
  },
  externals: [nodeExternals()],
  module: {
    rules: [
      {
        // Transpiles ES6-8 into ES5
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader',
        },
      },
    ],
  },
};

请帮助我们使用Swagger中间件创建构建版本。

提前致谢。

- Raja Sekar

Answer 1

Swagger工具不像webpack一样是一个包捆绑器。因此，您仍然需要提供控制器文件。由于您从生产环境中删除了/public，因此swagger工具中间件无法获取所需的文件。在这种情况下，webpack基本上是从您的代码构建dist，这就是为什么删除控制器和服务是可以的原因。

- Edward Romero