Swagger UI 介绍
Swagger是个前后端协作的利器，解析 代码 里的注解 生成 jsON 文件 ，通过Swagger UI 生成 网页版的 接口文档 ，可以在上面做简单的接口调试 。
实现原理：
因为Swagger-ui读取的数据来源于/v2/api-docs，并且返回的是json数据。?
所以只要自己写 一个 页面 去解析json数据，并展现就可以实现 自定义 swagger的UI界面了?
如何使用Swagger
1、引入 jar包
首首先需要在你的 pom.xml 中引入swagger的包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
2.启用swagger
启用swagger,创建SwaggerCon fig 文件 ， 内容 如下，
@Con fig uration
@EnableSwagger2
public class SwaggerCon fig {
@Bean
public Docket ProductApi() {
return new Docket(DocumentationType.SWAGGER_2)
.genericModelSubstitutes(DeferredResult.class)
.useDefaultResponseMessages(false)
.forCodeGeneration(false)
.pathMapping("/")
.select()
.build()
.apiInfo(productApiInfo());
}
private ApiInfo productApiInfo() {
ApiInfo apiInfo = new ApiInfo("XXX系统数据 接口文档 ",
"文档描述。。。",
"1.0.0",
"API TERMS URL",
"联系人邮箱",
"license",
"license url");
return apiInfo;
}
}
3. 添加 swagger注解
常用的swagger注解?
Api?
ApiModel?
ApiModelProperty?
ApiOperation?
ApiP ara m?
ApiResponse?
ApiResponses?
ResponseHeader?
具体可以参考swagger官方注解文档：http://docs.swagger.io/swagger-core/apidocs/index.html
4. 添加 自定义 UI界面
有两种方式?
1.可以在项目的基础上新增 一个 servlet,指向对应的html 文件 ?
html 文件 里再去解析json，并渲染UI
2.新建 一个 项目，用webjars将前端资源打成 jar包 ，再供其他项目使用?
网站地址 : http://swagger.io
GitHub: https://github.com/swagger-api/swagger-ui
网站描述: 一个 Restful风格接口的文档在线 自动 生成 和测试的框架
Swagger UI官方网站
官方网站： http://swagger.io
如果觉得 网站内容还不错，欢迎将 网站 推荐给程序员好友。