Linux上Swagger文檔如何生成

在Linux系統上生成Swagger文檔通常涉及以下幾個步驟：

1. 添加Swagger依賴：

• 對于Maven項目，在pom.xml文件中添加以下依賴：

<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>

注意：版本號應根據您的Spring Boot版本進行調整，以避免兼容性問題。

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.basePackage("com.example.yourproject")) // 這里寫你的Controller包路徑
                .paths(PathSelectors.any())
                .build();
    }
}

這段代碼會啟用Swagger 2并允許所有請求和路徑。

3. 啟動項目：

• 啟動您的Spring Boot應用程序。確保Swagger UI已經成功啟動并可以在瀏覽器中訪問，通?？梢酝ㄟ^訪問http://localhost:8080/swagger-ui.html來查看Swagger UI。

4. 生成和查看Swagger文檔：

• 在Swagger UI頁面中，點擊“Authorize”按鈕，然后點擊“Download Swagger JSON”按鈕。這將下載一個包含所有API信息的JSON文件。您也可以選擇導出為YAML格式，只需點擊“Download Swagger YAML”按鈕即可。

5. 使用Swagger Editor（可選）：

• Swagger Editor是一個用于編寫OpenAPI規范的開源編輯器，提供了可視化的界面，使得用戶可以更加方便地編寫和管理API文檔。您可以使用Docker來部署Swagger Editor，并通過內網穿透工具實現遠程訪問。

以上步驟適用于基于Java的Spring Boot項目。如果您使用的是其他編程語言，例如Python或Node.js，生成Swagger文檔的方法可能會有所不同。對于Python項目，可以使用Flask框架結合flask-swag或flasgger庫來生成Swagger文檔。對于Node.js項目，可以使用swagger-jsdoc和swagger-ui-express來配置和生成Swagger文檔。