Swagger文档在Debian的生成方法

技术教程
2025-06-13 09:26:33

在debian系统上生成openapi规范（曾被称为swagger）文档，通常会结合spring boot框架进行开发与接口文档化。以下是完整的操作流程：

安装J*a和M*en：确保你的Debian系统中已安装J*a和M*en。如果尚未安装，可以使用以下命令进行安装：
```
 sudo apt update
 sudo apt install openjdk-11-jdk m*en
```
创建Spring Boot项目：使用Spring Initializr来生成一个新的Spring Boot项目。选择你需要的依赖项（例如Spring Web），然后下载项目压缩包。
解压并导入IDE：将下载的项目解压至本地目录，并通过你常用的开发工具（如IntelliJ IDEA或Eclipse）导入该项目。

添加Swagger依赖：打开项目的pom.xml文件，并加入以下Swagger相关的依赖配置：

 <dependencies><dependency><groupid>io.springfox</groupid><artifactid>springfox-swagger2</artifactid><version>2.9.2</version></dependency><dependency><groupid>io.springfox</groupid><artifactid>springfox-swagger-ui</artifactid><version>2.9.2</version></dependency></dependencies>

请根据当前使用的Spring Boot版本适当调整版本号，以确保兼容性。

配置Swagger功能：创建一个用于启用和配置Swagger的类文件。在src/main/j*a/com/yourpackage路径下新建名为SwaggerConfig.j*a的配置类：

 package com.yourpackage;

 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 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.basePackage("com.yourpackage")) // 修改为你自己的Controller所在包路径
                 .paths(PathSelectors.any())
                 .build();
     }
 }

启动Spring Boot应用：在IDE内运行该Spring Boot程序，或者通过终端执行如下M*en命令启动：
Kuwebs企业网站管理系统3.1.5 UTF8
酷纬企业网站管理系统Kuwebs是酷纬信息开发的为企业网站提供解决方案而开发的营销型网站系统。在线留言模块、常见问题模块、友情链接模块。前台采用DIV+CSS，遵循SEO标准。 1.支持中文、英文两种版本，后台可以在不同的环境下编辑中英文。 3.程序和界面分离，提供通用的PHP标准语法字段供前台调用，可以为不同的页面设置不同的风格。 5.支持google地图生成、自定义标题、自定义关键词、自定义描
1 查看详情
```
 mvn spring-boot:run
```
访问Swagger UI界面：应用启动完成后，在浏览器输入以下地址访问Swagger UI页面：
```
 http://localhost:8080/swagger-ui.html
```
此时你应该能看到展示所有API信息的图形化界面。

添加API描述注解：在控制器类中引入适当的Swagger注解，从而增强接口说明。示例代码如下：

 package com.yourpackage.controller;

 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;

 @RestController
 @RequestMapping("/api")
 @Api(tags = "示例控制器")
 public class ExampleController {

     @GetMapping("/hello")
     @ApiOperation(value = "返回Hello World", notes = "根据用户ID获取用户信息")
     public String sayHello() {
         return "Hello, World!";
     }
 }