接口文档编写也许是每个程序猿不擅长的事情,swagger2注解提供了优雅的接口展示,原生的swagger2提供接口UI界面不是很优雅,然而swagger-bootstrap-ui为swagger2改善了优雅展示;从此一切变的很安静;直接上代码
- pom.xml 文件引入jar
<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>
<!-- 优化界面UI -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
- SwaggerConfig 类配置
@Configuration
@EnableSwagger2
public class SwaggerConfig{
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("pc")
.select()
// 自行修改为自己的包路径
.apis(RequestHandlerSelectors.basePackage("com.neo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("客户管理")
.description("客户管理中心 API 1.0 操作文档")
//服务条款网址
.termsOfServiceUrl("http://llhui.com/")
.version("1.0")
.contact(new Contact("嘻嘻哈哈", "http://llhui.com/", "llhui20@sina.com"))
.build();
}
}
- 浏览器 http://localhost:8080/doc.html