在Linux系統(tǒng)上集成Swagger，步驟如下：
第一步：安裝Java運(yùn)行環(huán)境
Swagger依賴Java運(yùn)行環(huán)境。使用OpenJDK或oracle JDK均可。以下命令適用于基于Debian/Ubuntu的Linux發(fā)行版：
sudo apt update sudo apt install openjdk-11-jdk
第二步：配置構(gòu)建工具 (maven或gradle)
若使用Maven或Gradle構(gòu)建項(xiàng)目，需正確配置Swagger依賴。
Maven配置 (pom.xml):
<dependencies> <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>
Gradle配置 (build.gradle):
dependencies { implementation 'io.springfox:springfox-swagger2:2.9.2' implementation 'io.springfox:springfox-swagger-ui:2.9.2' }
第三步：Swagger配置
創(chuàng)建一個(gè)Swagger配置類，啟用Swagger文檔生成。以下示例適用于spring boot和Spring mvc框架：
Spring Boot/spring mvc 配置類 (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; 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.any()) .paths(PathSelectors.any()) .build(); } }
第四步：運(yùn)行應(yīng)用
啟動(dòng)你的Spring Boot或Spring MVC應(yīng)用。Swagger會(huì)自動(dòng)生成API文檔。
第五步：訪問Swagger UI
在瀏覽器中訪問 http://localhost:8080/swagger-ui.html (端口號(hào)根據(jù)實(shí)際情況調(diào)整)，即可查看和測(cè)試API文檔。
以上步驟提供了一個(gè)在Linux環(huán)境下集成Swagger的通用指南。具體實(shí)現(xiàn)可能因項(xiàng)目結(jié)構(gòu)和依賴差異而略有不同。 請(qǐng)確保你的項(xiàng)目已正確配置并包含必要的依賴。
.png)
推廣.jpg)