SwaggerUI是什么

如题所述

Swagger UI是一个开源类的专业文档工具,它是由三大资产方的集合(html、js、css),它能够帮助我们简化对apl的开发。它是一个工具集合体,是一个简单并且容易上手使用的工具,简直是码农大爷的快乐,新农们的福音!
Swagger UI介绍:
1、高效
这是一款非常强大的文档软件,可以帮助用户高效编辑。
2、兼容
集合HTML、Java、CSS等等,拥有非常强悍的内核性能。
3、专业
非常适合专业的开发人员,可以高效完成API的开发编辑。
4、干净
1、界面非常清爽简洁,没有广告和弹窗,用户可以专心使用。
Swagger UI如何使用(自定义UI界面):
Swagger是安静风格的界面文档在线智能世代和测试框架。
Swagger UI的UI 界面如下:
一、界面简介:
1、我认为有些不漂亮,也不明确。特别是request 的model部分。
2、所以我想重新设计更亲切更美丽的UI 界面。
二、最终渲染如下:
1、界面文档信息界面。
2、接口文档调试界面。
3、实现原则:
(1)从Swagger-UI读取的数据来自/v2/api-docs,因此返回JSON数据。
(2)因此,您只需解析JSON数据并创建显示自定义影院的UI 界面的页面即可。
三、如何使用swagger。
1、引入jar包。
(1)首先,必须在POM、XML中引入Swagger软件包。
2、启用swagger。
(1)激活Swagger并创建SwaggerConfig文件,如下所示:
3、添加Swagger注释。
(1)Api.
(2)ApiModel.
(3)ApiModelProperty.
(4)ApiOperation.
(5)ApiParam.
(6)ApiResponse.
(7)ApiResponses.
(8)ResponseHeader.
4、添加自定义UI 界面。
有两种方法:
(1)可以添加基于项目的servlet,指向相应的html文件,。
分析HTML文件中的JSON并呈现UI。
(2)新项目,使用webjars将前端资源放入jar包中,用于其他项目。
项目结构如下:
主文件为docs、html、分析JSON和渲染UI。
Ajax请求v2/api-docs并分析JSON。
使用JSRENDER模板引擎的页面来方便页面。
四、使用swagger-ui-layer。
1、现在已经将项目在github上开源了,取名为swagger-ui-layer。
2、欢迎star,fork,commit,也可以随意修改成自己喜欢的UI风格。
3、要使用swagger-ui-layer很简单。
4、只需要在pom.xml中加入引用最新版本jar包就可以了。
5、然后就可以直接查看效果了。
温馨提示:答案为网友推荐,仅供参考