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,创建SwaggerConfig文件,内容如下,
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@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
ApiParam
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
小编说
以上是编程之家为你收集整理的Swagger UI全部内容。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。