Swagger UI零基础入门_一个Restful风格接口的文档在线自动生成和测试的框架

Swagger UI零基础入门

官方网址: http://swagger.io

Swagger UI零基础入门_一个Restful风格接口的文档在线自动生成和测试的框架

GitHub: https://github.com/swagger-api/swagger-ui

简介描述:一个Restful风格接口的文档在线自动生成和测试的框架

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包,再供其他项目使用 

海计划公众号
awesome-blockchain-cn基础知识教程_一个区块链学习的 github 项目
上一篇 2020/03/06 08:31
prepack入门基础教程_一个优化JavaScript源代码的工具
下一篇 2020/03/06 08:31

您可能感兴趣的内容

热门推荐

代做工资流水公司武汉做企业对公流水济南银行流水账打印岳阳代办房贷流水桂林贷款工资流水 费用济南对公流水制作南通对公银行流水模板镇江对公银行流水多少钱石家庄银行流水修改公司杭州企业流水打印报价济宁流水单价格舟山银行流水账单代开廊坊查银行对公流水徐州银行流水电子版制作汕头做房贷银行流水孝感企业流水打印办理揭阳流水单制作长春房贷流水样本泰安房贷工资流水 办理蚌埠对公银行流水样本杭州代做个人银行流水黄冈银行流水PS模板绍兴打转账流水惠州工资代付流水图片嘉兴银行流水电子版办理中山公司银行流水打印上海在职证明办理株洲代开离职证明兰州查询在职证明邢台入职工资流水模板深圳离职证明模板香港通过《维护国家安全条例》两大学生合买彩票中奖一人不认账让美丽中国“从细节出发”19岁小伙救下5人后溺亡 多方发声卫健委通报少年有偿捐血浆16次猝死汪小菲曝离婚始末何赛飞追着代拍打雅江山火三名扑火人员牺牲系谣言男子被猫抓伤后确诊“猫抓病”周杰伦一审败诉网易中国拥有亿元资产的家庭达13.3万户315晚会后胖东来又人满为患了高校汽车撞人致3死16伤 司机系学生张家界的山上“长”满了韩国人?张立群任西安交通大学校长手机成瘾是影响睡眠质量重要因素网友洛杉矶偶遇贾玲“重生之我在北大当嫡校长”单亲妈妈陷入热恋 14岁儿子报警倪萍分享减重40斤方法杨倩无缘巴黎奥运考生莫言也上北大硕士复试名单了许家印被限制高消费奥巴马现身唐宁街 黑色着装引猜测专访95后高颜值猪保姆男孩8年未见母亲被告知被遗忘七年后宇文玥被薅头发捞上岸郑州一火锅店爆改成麻辣烫店西双版纳热带植物园回应蜉蝣大爆发沉迷短剧的人就像掉进了杀猪盘当地回应沈阳致3死车祸车主疑毒驾开除党籍5年后 原水城县长再被查凯特王妃现身!外出购物视频曝光初中生遭15人围殴自卫刺伤3人判无罪事业单位女子向同事水杯投不明物质男子被流浪猫绊倒 投喂者赔24万外国人感慨凌晨的中国很安全路边卖淀粉肠阿姨主动出示声明书胖东来员工每周单休无小长假王树国卸任西安交大校长 师生送别小米汽车超级工厂正式揭幕黑马情侣提车了妈妈回应孩子在校撞护栏坠楼校方回应护栏损坏小学生课间坠楼房客欠租失踪 房东直发愁专家建议不必谈骨泥色变老人退休金被冒领16年 金额超20万西藏招商引资投资者子女可当地高考特朗普无法缴纳4.54亿美元罚金浙江一高校内汽车冲撞行人 多人受伤

代做工资流水公司 XML地图 TXT地图 虚拟主机 SEO 网站制作 网站优化