Ubuntu上Swagger API文檔怎樣生成

在Ubuntu上為Spring Boot應用程序配置Swagger并生成API文檔，可以按照以下步驟進行：

1. 添加Swagger依賴

在你的Spring Boot項目的 pom.xml 文件中添加Swagger相關的依賴。例如：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <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>

2. 配置Swagger

創建一個Java類來配置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.basePackage("com.yourpackage")) // 替換為你的控制器包路徑
                .paths(PathSelectors.any())
                .build();
    }
}

3. 啟動Spring Boot應用程序

在終端中運行以下命令來啟動Spring Boot應用：

./mvnw spring-boot:run

4. 訪問Swagger UI

啟動應用程序后，你可以通過瀏覽器訪問Swagger UI界面。默認情況下，你可以通過以下URL訪問：

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

這里假設你的應用程序運行在8080端口上。

5. 生成Swagger文檔

在Swagger UI界面中，你可以：

• 點擊“Authorize”（如有需要）進行授權。
• 點擊“Download Swagger JSON”下載JSON格式的API文檔。
• 點擊“Download Swagger YAML”下載YAML格式的API文檔。

6. 使用Swagger Editor（可選）

Swagger Editor是一個可視化編輯器，方便編寫和管理OpenAPI規范。你可以使用Docker部署并通過內網穿透工具遠程訪問。

通過以上步驟，你可以在Ubuntu上成功配置Swagger并生成API文檔。如果有任何問題，請檢查你的依賴版本是否兼容，并確保你的Spring Boot應用程序正確運行。