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文档。