swagger配置正式环境中不可访问的问题

当我们在开发阶段使用Swagger来管理我们的REST API时，它对于我们进行API测试、API文档编写非常友好。但是在发布到正式环境时，我们需要注意以下几点，避免Swagger配置的API在正式环境中被未经授权的用户访问。

1. 在生产环境中禁用Swagger UI

Swagger UI是Swagger的一个核心组件，它用于在浏览器中呈现API文档，并提供交互式的API测试工具。但是，Swagger UI也会对我们的应用程序的安全性产生潜在的威胁。为了避免Swagger UI被未经授权的用户访问，我们可以在生产环境中禁用Swagger UI。常见的做法是通过将Swagger UI的路由信息置于一个受保护的路由之下。

以Node.js Express框架为例，下面的代码片段展示了如何将Swagger UI置于一个受保护的路由之下。在生产环境中，我们可以使用基于环境变量的条件语句来判断是否需要启用Swagger UI。

const express = require('express');
const app = express();

if(process.env.NODE_ENV !== 'production') {
  const swaggerUi = require('swagger-ui-express');
  const swaggerDocument = require('./swagger.json');
  app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
}

2. 使用swagger-jsdoc和swagger-ui-express在生产环境中隐藏Swagger配置

Swagger-jsdoc是一个很棒的库，它可以让我们在代码中使用JSDoc格式为我们的REST API创建Swagger文档。在生产环境中，我们可以使用swagger-ui-express将Swagger配置绑定到受保护的路由中，这可以防止未经授权的用户访问我们的Swagger文档。

下面是如何在Node.js Express框架中使用swagger-jsdoc和swagger-ui-express，在生产环境中隐藏Swagger配置。

const express = require('express');
const app = express();
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const options = {
  swaggerDefinition: {
    openapi: '3.0.0',
    info: {
      title: 'My API',
      version: '1.0.0',
      description: 'API documentation using swagger and jsdoc'
    },
  },
  apis: ['./routes/*.js'], // 文件路径
};

const specs = swaggerJsdoc(options);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));

上面的代码会将我们的Swagger文档绑定到“/api-docs”路由中，而只有在NODE_ENV环境变量设置为“development”时，文档才会在该路由下可访问。

以上是关于“Swagger配置正式环境中不可访问的问题”的完整攻略，希望能对你有所帮助。