本文介紹如何在Linux系統上生成Swagger文檔，主要針對基于spring Boot的Java項目。其他語言（如Python或Node.JS）的實現方法略有不同。
一、添加Swagger依賴 (maven項目)
在pom.xml文件中添加以下依賴項，版本號請根據您的spring boot版本調整：
<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配置 (Spring Boot)
創建一個配置類，例如SwaggerConfig.java，并添加如下代碼：
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.example.yourproject")) // 請替換為您的Controller包路徑 .paths(PathSelectors.any()) .build(); } }
請將”com.example.yourproject”替換為您的項目中Controller所在的包路徑。
三、啟動項目并訪問Swagger UI
啟動Spring Boot應用后，通常可以通過http://localhost:8080/swagger-ui.html訪問Swagger UI界面。
四、生成Swagger文檔
在Swagger UI界面中，您可以：
- 點擊“Authorize”（如有需要）進行授權。
- 點擊“Download Swagger JSON”下載json格式的API文檔。
- 點擊“Download Swagger YAML”下載YAML格式的API文檔。
五、使用Swagger Editor (可選)
Swagger Editor是一個可視化編輯器，方便編寫和管理OpenAPI規范。您可以使用docker部署并通過內網穿透工具遠程訪問。
其他語言框架的Swagger集成:
對于Python (flask) 項目，可以考慮使用flask-swag或flasgger庫；Node.js項目可以使用swagger-jsdoc和swagger-ui-express。 具體的集成方法請參考這些庫的官方文檔。
