Linux上Swagger文檔怎么生成

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

安裝必要的工具

• Java JDK：Swagger工具通常需要Java環境。
• Maven或Gradle：用于管理項目依賴和構建過程。
• Swagger Codegen：用于生成客戶端代碼、API文檔等。

設置項目

• 創建一個新的Maven或Gradle項目。
• 在項目的pom.xml（對于Maven）或build.gradle（對于Gradle）文件中添加Swagger Codegen的依賴。

編寫API規范

• 使用OpenAPI Specification（OAS）編寫API規范文件，通常是swagger.yaml或swagger.json。

生成代碼和API文檔

• 使用Swagger Codegen CLI工具生成客戶端代碼、API文檔等。
  • 生成客戶端代碼示例：

    java -jar swagger-codegen-cli.jar generate \
    -i path/to/swagger.yaml \
    -l java \
    -o path/to/output/directory
    

  • 生成API文檔示例：

    java -jar swagger-codegen-cli.jar generate \
    -i path/to/swagger.yaml \
    -l html2 \
    -o path/to/output/directory
    

集成到構建過程

• 將Swagger Codegen集成到Maven或Gradle的構建過程中，以便在每次構建時自動生成代碼和文檔。

使用Springfox生成Swagger文檔（針對Spring Boot項目）

• 添加Springfox依賴： 在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>
  

• 配置Swagger： 創建一個Swagger配置類，例如：

  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;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  @Configuration
  @EnableSwagger2
  public class SwaggerConfig {
      @Bean
      public Docket api() {
          return new Docket(DocumentationType.SWAGGER_2)
                  .select()
                  .apis(RequestHandlerSelectors.basePackage("com.example.yourpackage"))
                  .paths(PathSelectors.any())
                  .build()
                  .apiInfo(new ApiInfoBuilder()
                          .title("API 文檔")
                          .description("這是 Spring Boot 項目的 API 文檔")
                          .version("1.0")
                          .build());
      }
  }
  

• 訪問Swagger UI： 啟動Spring Boot應用程序后，可以通過以下URL訪問Swagger UI：

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

以上步驟可以幫助你在Linux系統上生成Swagger文檔。根據你的具體需求和技術棧，可以選擇合適的方法進行操作。