在Linux系统中集成和测试Swagger主要涉及以下几个步骤:
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>
build.gradle
文件中添加以下依赖:implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'
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.yourpackage.controller"))
.paths(PathSelectors.any())
.build();
}
}
http://localhost:8080/swagger-ui.html
(假设你的应用程序运行在端口8080上)来查看和测试API文档。这是一个更简单的方法,可以避免依赖管理的复杂性:
sudo apt-get update
sudo apt-get install -y docker.io
sudo systemctl start docker
sudo systemctl enable docker
docker pull swaggerapi/swagger-ui:latest
docker pull swaggerapi/swagger-editor:latest
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest
docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest
http://localhost:8080
http://localhost:8081
npm install -g swagger
或者下载Swagger UI的静态文件并部署到你的Web服务器上。
以上步骤应该能够帮助你在Linux系统中成功集成Swagger,并进行API的文档化和测试。