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端點是安全的，避免未授權的訪問?？梢詤⒖枷嚓P示例，使用Nest.js的安全機制來保護Swagger UI。
• 依賴管理：確保所有依賴項都是最新的，以避免安全漏洞。

以上步驟提供了一個基本的指南，具體的自定義選項可能會根據你使用的Swagger UI版本和你的特定需求而有所不同。如果你需要更高級的自定義，你可能需要查看Swagger UI的官方文檔或尋求社區的幫助。