Swagger API文檔如何在Debian生成

在Debian系統上生成Swagger API文檔，通常需要以下幾個步驟：

1. 安裝Node.js和npm（如果尚未安裝）：

   sudo apt update
   sudo apt install -y nodejs npm
   

2. 安裝Swagger相關依賴：

   npm install --save @nestjs/swagger swagger-ui-express
   

3. 配置Swagger： 在你的Nest.js項目中，創建一個配置文件（例如swagger.config.ts），并配置Swagger文檔的基本信息。例如：

   import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
   import { AppModule } from './app.module';
   
   export const swaggerConfig = new DocumentBuilder()
     .setTitle('你的服務名稱')
     .setDescription('你的服務描述')
     .setVersion('1.0')
     .build();
   
   export const createSwaggerDocument = (app: ExpressApplication) => {
     const document = SwaggerModule.createDocument(app, swaggerConfig);
     SwaggerModule.setup('docs', app, document);
   };
   
   async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     createSwaggerDocument(app);
     await app.listen(3000);
   }
   
   bootstrap();
   

4. 啟動項目： 在項目根目錄下運行以下命令啟動你的Nest.js應用：

   npm run start:dev
   

5. 訪問Swagger UI： 啟動應用后，打開瀏覽器并訪問http://localhost:3000/docs，你應該能夠看到Swagger UI界面，其中展示了你的API文檔。

如果你使用的是Spring Boot項目，步驟類似，但需要使用Springfox庫來配置Swagger。以下是一個簡單的Spring Boot配置示例：

1. 添加依賴： 在pom.xml中添加以下依賴：

   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.7.0</version>
   </dependency>
   <dependency>
       <groupId>com.github.xiaoymin</groupId>
       <artifactId>swagger-bootstrap-ui</artifactId>
       <version>1.9.6</version>
   </dependency>
   

2. 配置Swagger： 創建一個配置類（例如SwaggerConfig.java）：

   import springfox.documentation.builders.PathSelectors;
   import springfox.documentation.builders.RequestHandlerSelectors;
   import springfox.documentation.spi.DocumentationType;
   import springfox.documentation.spring.web.plugins.Docket;
   import springfox.documentation.swagger2.annotations.EnableSwagger2;
   
   @Configuration
   @EnableSwagger2
   public class SwaggerConfig {
       @Bean
       public Docket api() {
           return new Docket(DocumentationType.SWAGGER_2)
               .select()
               .apis(RequestHandlerSelectors.any())
               .paths(PathSelectors.any())
               .build();
       }
   }
   

3. 啟動應用： 啟動你的Spring Boot應用，并訪問http://localhost:8080/swagger-ui.html，你應該能夠看到Swagger UI界面。

通過以上步驟，你可以在Debian系統上成功生成并訪問Swagger API文檔。