文档介绍:swagger自定义ui界面
Swagger简单介绍
如何使用Swagger
添加自定义UI界面
使用swagger-ui-layer
Swagger简单介绍
Swagger是一个Restful风格接口的文档在线自动生成和测试的框架
官网:
官方描述:The World’s Most Popular Framework for APIs.
Swagger ui 的原生UI界面如下: 个人感觉原生UI显示的有些不够漂亮和清晰,特别是request 的model部分
所以想重新设计一个更加友好美观的UI界面。
最后的效果图如下:
接口文档信息界面接口文档调试界面
实现原理:
因为Swagger-ui读取的数据来源于/v2/api-docs,并且返回的是json数据。
所以只要自己写一个页面去解析json数据,并展现就可以实现自定义swagger的UI界面了
如何使用Swagger
1、引入jar包
首先需要在你的 中引入swagger的包
springfox-swagger2
12345
启用swagger ,创建SwaggerConfig文件,内容如下,
***@Configuration
***@EnableSwagger2
public class SwaggerConfig {
***@Bean
public Docket ProductApi() {
return new Docket()
.genericModelSubstitutes()
.useDefaultResponseMessages(false)
.forCodeGeneration(false)
.pathMapping("/")
.select()
.build()
.apiInfo(productApiInfo());
}
private ApiInfo productApiInfo() {
ApiInfo apiInfo = new ApiInfo("XXX系统数据接口文档",
"文档描述。。。",
"",
"API TERMS URL",
"联系人邮箱",
"license",
"license url");
return apiInfo;
}
}12345678910111213