在开发过程中,我们经常需要使用Swagger来生成API文档,方便进行接口调试和文档管理。但是默认的Swagger页面通常比较简陋,需要手动输入接口地址来查看文档,使用起来不够友好。为了更好地展示API文档,我们可以集成Swagger-Bootstrap-UI,使页面更加清爽、易用。
1. 引入Swagger-Bootstrap-UI依赖
首先,在你的Spring Boot项目中的pom.xml
文件中添加Swagger-Bootstrap-UI的依赖:
<dependency>
<groupId>io.github.xiaoyudeguang</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
这个依赖会自动集成Swagger和Swagger-UI,并提供更加漂亮的界面。
2. 配置Swagger
在Spring Boot项目中,通过创建一个Swagger配置类来配置Swagger的相关参数:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API文档")
.description("Spring Boot集成Swagger-Bootstrap-UI")
.version("1.0")
.build();
}
}
在上面的代码中,我们可以设置API文档的标题、描述和版本等信息。
3. 访问Swagger-Bootstrap-UI页面
启动Spring Boot项目后,可以通过访问http://localhost:8080/swagger-ui.html
来查看Swagger-Bootstrap-UI生成的API文档。你将会看到一个漂亮的、更加清爽的页面,同时还可以进行接口调试。
4. Swagger-Bootstrap-UI页面特性
Swagger-Bootstrap-UI提供了很多实用的功能,让我们更方便地管理和查看API文档。
4.1 接口分组
Swagger-Bootstrap-UI允许我们对API接口进行分组,可以根据不同的模块对接口进行分类,方便查找和管理。
4.2 参数示例
Swagger-Bootstrap-UI允许我们为接口的参数提供示例值,方便理解和调试接口。
4.3 返回结果模型
Swagger-Bootstrap-UI可以自动解析接口返回结果的模型,以清晰的树状结构展示,方便查看数据结构。
4.4 在线调试
Swagger-Bootstrap-UI提供了在线调试的功能,可以直接在页面上进行接口请求,方便快速测试接口。
结语
通过集成Swagger-Bootstrap-UI,我们可以得到一个更加清爽、易用的API文档页面,方便接口的调试和管理。不仅如此,Swagger-Bootstrap-UI还提供了很多实用的功能,使我们更加高效地开发和测试API接口。
如果你还没有尝试过Swagger-Bootstrap-UI,赶快集成到你的Spring Boot项目中吧!你一定会爱上它的!
本文来自极简博客,作者:柔情密语酱,转载请注明原文链接:SpringBoot集成Swagger-Bootstrap-UI,页面更清爽!