在debian系統上生成openapi規范（曾被稱為swagger）文檔，通常會結合spring boot框架進行開發與接口文檔化。以下是完整的操作流程：
-
安裝Java和maven： 確保你的Debian系統中已安裝Java和Maven。如果尚未安裝，可以使用以下命令進行安裝：
sudo apt update sudo apt install openjdk-11-jdk maven
-
創建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/java/com/yourpackage路徑下新建名為SwaggerConfig.java的配置類：
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程序，或者通過終端執行如下Maven命令啟動：
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!"; } } -
刷新查看更新內容： 每次修改完Swagger相關配置或添加新的注解后，重新啟動服務并在瀏覽器刷新Swagger UI頁面以便查看最新文檔。
按照上述步驟操作，即可順利地在基于Debian的操作系統上完成Spring Boot與Swagger集成，并利用其強大的UI功能對API進行可視化管理和測試。
