spring boot 使用swagger2构建RESTful API文档的方法就不多说了,网上资料一堆。
一、引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
二、创建Swagger2配置类
swagger2配置类与启动类同级,注解具体含义可查看文档理解
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket CreateRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.any())
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.paths(PathSelectors.regex("/.*"))
.build();
}
private ApiInfo apiInfo () {
return new ApiInfoBuilder()
.title("zcool ranking")
.description("no description")
.termsOfServiceUrl("https://www.XXX.XXX")
.contact(new Contact("zyy", "", "zyy@163.com.cn"))
.version("V1.0")
.build();
}
}
在具体的接口类上添加相应的注解,运行启动,访问
ip:port/swagger-ui.html即可。
**
重点来了,一开始UI页面正常展示接口说明,后来修改配置之后出错,页面空白,无论再怎么修改正确都是空白页。不要怀疑自己,清除浏览器缓存就好了,是的,就是清除浏览器缓存。
**
感谢这位博主的提醒:https://blog.csdn.net/chrise_/article/details/79754469