在Linux系统上集成Swagger,步骤如下:
第一步:安装Java运行环境
Swagger依赖Java运行环境。使用OpenJDK或oracle JDK均可。以下命令适用于基于Debian/Ubuntu的Linux发行版:
sudo apt update sudo apt install openjdk-11-jdk
若使用Maven或Gradle构建项目,需正确配置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配置
创建一个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(); } }
第四步:运行应用
启动你的Spring Boot或Spring MVC应用。Swagger会自动生成API文档。
第五步:访问Swagger UI
在浏览器中访问 http://localhost:8080/swagger-ui.html (端口号根据实际情况调整),即可查看和测试API文档。
以上步骤提供了一个在Linux环境下集成Swagger的通用指南。具体实现可能因项目结构和依赖差异而略有不同。 请确保你的项目已正确配置并包含必要的依赖。