Swagger在Debian中的兼容性問題

在Debian中使用Swagger（現稱為OpenAPI）主要涉及以下幾個步驟：

1. 環境準備：

   • 確保你的Debian系統已經安裝了Java和Maven（或其他構建工具）。Swagger通常與Spring Boot項目一起使用，因此你需要一個Spring Boot項目模板。
   • 更新包列表：

     sudo apt update
     

   • 安裝Java（以OpenJDK為例）：

     sudo apt install openjdk-11-jdk
     

   • 驗證Java安裝：

     java -version
     

   • 安裝Maven：

     sudo apt install maven
     

   • 驗證Maven安裝：

     mvn -version
     

2. 創建Spring Boot項目：

   • 你可以使用Spring Initializr（https://start.spring.io/）來創建一個新的Spring Boot項目，選擇必要的依賴，例如springfox-boot-starter。

3. 引入Swagger依賴：

   • 在你的Spring Boot項目的pom.xml文件中添加Swagger依賴：

     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-boot-starter</artifactId>
         <version>3.0.0</version>
     </dependency>
     

4. 配置Swagger：

   • 在application.yml或application.properties文件中配置Swagger：

     springfox:
       documentation:
         swagger-ui:
           enabled: true
     

     或

     springfox.documentation.swagger-ui.enabled=true
     

5. 啟動項目：

   • 啟動你的Spring Boot項目，通?？梢酝ㄟ^以下命令：

     mvn spring-boot:run
     

6. 訪問Swagger UI：

   • 項目啟動后，打開瀏覽器，訪問以下URL來查看Swagger生成的API文檔：

     http://localhost:8080/swagger-ui/
     

7. 編寫API接口并使用Swagger注解：

   • 在你的控制器類中使用Swagger注解來描述API接口：

     import io.swagger.annotations.*;
     import org.springframework.web.bind.annotation.*;
     
     @RestController
     @RequestMapping("/api")
     @Api(tags = "Sample API")
     public class SampleController {
         @GetMapping("/hello")
         @ApiOperation(value = "Say hello", response = String.class)
         public String sayHello() {
             return "Hello, World!";
         }
     
         @PostMapping("/data")
         @ApiOperation(value = "Send data", requestBody = @io.swagger.annotations.ApiRequestBody(content = @io.swagger.annotations.ApiContent(schema = @io.swagger.annotations.ApiSchema(implementation = String.class))), response = String.class)
         public String sendData(@RequestBody String data) {
             return "Received: " + data;
         }
     }
     

8. 訪問API文檔：

   • 在Swagger UI中，你可以看到所有通過注解描述的API接口，可以在線嘗試調用這些接口，查看請求和響應示例。

注意事項：

• 確保你的Spring Boot項目版本與springfox-boot-starter版本兼容。
• 如果遇到任何問題，可以查看Swagger的官方文檔或在社區尋求幫助。