要在CentOS上将Swagger与Spring Boot集成,你需要遵循以下步骤:
pom.xml
文件中添加Swagger和Swagger UI的依赖。<dependencies>
<!-- Swagger 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>
请注意,版本号可能会随着时间而变化,所以请检查最新的版本。
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")) // 替换为你的控制器包路径
.paths(PathSelectors.any())
.build();
}
}
访问Swagger UI:启动你的Spring Boot应用程序后,你可以通过浏览器访问Swagger UI界面。默认情况下,URL应该是 http://<your-server-ip>:<port>/swagger-ui.html
。
(可选)自定义Swagger UI:如果你想要自定义Swagger UI的外观或者行为,你可以修改SwaggerConfig
类中的配置,或者添加额外的配置参数。
运行和测试:确保你的Spring Boot应用程序正在运行,并且你可以通过浏览器访问Swagger UI界面来查看和测试你的API文档。
这些步骤应该可以帮助你在CentOS上运行的Spring Boot应用程序中集成Swagger。记得在部署到生产环境之前移除或禁用Swagger,因为它可能会暴露敏感信息。