Swagger在Debian上部署步骤解析

在Debian上部署Swagger的步骤如下：

1. 安装Node.js和npm

首先，确保你的系统上已经安装了Node.js和npm。如果没有安装，可以通过以下命令安装：

sudo apt update
sudo apt install -y nodejs npm

2. 安装Nest.js CLI

使用npm安装Nest.js CLI：

sudo npm install -g @nestjs/cli

3. 创建一个新的Nest.js项目

创建一个新的Nest.js项目：

nest new my-project
cd my-project

4. 安装Swagger UI依赖

在项目目录中，安装swagger-ui-express：

npm install @nestjs/swagger swagger-ui-express

5. 配置Swagger

打开src/main.ts文件，并进行以下配置：

import { NestFactory } from '@nestjs/core';
import { ExpressAdapter } from '@nestjs/platform-express';
import { AppModule } from './app.module';
import * as express from 'express';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule, new ExpressAdapter());
  app.use(express.json()); // for parsing application/json
  app.use(express.urlencoded({ extended: true })); // for parsing application/x-www-form-urlencoded

  // 配置 Swagger
  const options = new DocumentBuilder()
    .setTitle('My Project')
    .setDescription('The My Project API description')
    .setVersion('1.0')
    .addTag('test')
    .build();

  const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup('api-doc', app, document);

  await app.listen(3000);
}

bootstrap();

6. 运行项目

在项目目录中，运行以下命令启动项目：

npm run start:dev

7. 访问Swagger UI

项目启动后，你可以通过访问以下URL来查看Swagger UI：

http://localhost:3000/api-doc/#/

注意事项

• 安全性：确保你的Swagger UI端点是安全的，避免未授权的访问。可以参考相关示例，使用Nest.js的安全机制来保护Swagger UI。
• 依赖管理：确保所有依赖项都是最新的，以避免安全漏洞。

以上步骤提供了一个基本的指南，具体的自定义选项可能会根据你使用的Swagger UI版本和你的特定需求而有所不同。如果你需要更高级的自定义，你可能需要查看Swagger UI的官方文档或寻求社区的帮助。