Swagger 自定义UI界面
- Swagger简单介绍
- 如何使用Swagger
- 添加自定义UI界面
- 使用swagger-ui-layer
Swagger简单介绍
#最后的效果图如下：
- 接口文档信息界面
- 接口文档调试界面
实现原理：
如何使用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注解
4.添加自定义UI界面
主要文件是docs.html，此文件作用是解析json和渲染UI
通过ajax请求v2/api-docs,再解析json。
$.ajax({
url : "v2/api-docs", //url : "http://petstore.swagger.io/v2/swagger.json", dataType : "json", type : "get", success : function(data) {
//do something console.log(data); } }); 这里为了页面方便渲染，还用到了jsrender模板引擎
<dependency> <groupId>com.github.caspar-chen
groupId> <artifactId>swagger-ui-layer
artifactId> <version>最新版本
version>
dependency> 版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请联系我们举报，一经查实，本站将立刻删除。
发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/198466.html原文链接：https://javaforall.net
