【swagger】前后端分离联调利器——swagger安装和使用

news/2024/7/10 18:38:45 标签: angular, url, 前端开发, 互联网, 测试

一、前言

      互联网发展越来越迅速,近来项目中使用了前后端分离的模式。前端开发使用Angular4,后端开发使用SSM框架。这样的话就有了前后端联调的问题,接口数据类型,接口返回参数等等问题。项目初期的时候使用postman进行测试,但是测试比较麻烦,需要把url粘贴进去,然后再测试,后来发现了一个联调利器——swagger。

      经过了3个月使用,发现这个联调利器真的是很好使,所以记录下来,让大家一起研究。

二、安装部署

      与其说是安装部署,不如说是在项目中添加swagger的相关jar包,然后把swagger交给spring管理。通过访问相关url,就可以看到swagger的管理界面了。

2.1 在项目中依赖swagger相关的jar

      小编在web的项目pom中依赖:

      包括了springfox-swagger2和springfox-swagger-ui,小编引入的版本都是2.7.0

     <!--swagger-->
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>2.7.0</version>
     </dependency>
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>2.7.0</version>
     </dependency>

2.2 1. Springmvc的配置文件里添加

   <bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>
    <mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
    <mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

      添加完后的效果:

这里写图片描述

2.3 运行项目,打开swagger联调界面

      小编给web配置的tomcat的端口是8081,运行项目中,在浏览器中输入:http://localhost:8081/swagger-ui.html#/

      会看到如下界面:

这里写图片描述

      在显示的界面中会有所有的Controller,在每个Controller中会有包含的所有的接口,可以进行调试,举个例子:

      在小编项目中的place-manage-controller中,会有下面的接口,在swagger中也通过不同的颜色显示出了每个接口的responseMethod类型,绿色是post类型,棕色是put类型,红色是delete类型,蓝色是get类型。

这里写图片描述

      选择一个接口会有相关的调试方法:

这里写图片描述

      经过操作后,就会看到操作的结果:

这里写图片描述

三、swagger可以帮助提高代码质量

      在使用springmvc的时候我们需要制定接口的responseMethod类型,如果不写,在swagger中会把所的类型都显示出来:

这里写图片描述

      下次自己就知道要添加相关的类型了。

四、小结

      通过研究和使用swagger,个人感觉前后台联调的效率真的提高了,有的时候真的需要通过可视化界面来显示内容,如果还要通过excel来统计各个接口,是非常不方便的,而且接口变化还是很频繁的。欢迎更多前后端分离的项目来使用swagger。


http://www.niftyadmin.cn/n/1146047.html

相关文章

传谷歌首款Android手机HTC Dream23日上市

【赛迪网讯】9月11日消息&#xff0c;据国外媒体报道&#xff0c;近日&#xff0c;有消息称T-Mobile将于本月推出谷歌首款Android手机HTC Dream/G1。据国外媒体报道&#xff0c;此前曾有消息人士表示&#xff0c;谷歌首款Android手机将于10月份推出。而此次的新消息则表示&…

【MQ】ActiveMQ(二)——消息处理机制

一、前言 上文中&#xff0c;小编提到安装ActiveMQ&#xff0c;但是对于ActiveMQ中消息是用什么样的形式存储的&#xff1f;下面小编就向大家介绍一下。 二、消息类型 对于消息的传递有两种类型&#xff1a; 点对点的&#xff0c;即一个生产者和一个消费者一一对应&#xff1…

英特尔拟下周一发布六核芯片 面向虚拟系统

【赛迪网讯】9月11日消息&#xff0c;英特尔计划下周一发布六核至强7400芯片&#xff0c;同一天VMware将举行年度大会。这两者决非巧合。据国外媒体报道称&#xff0c;分析人士表示&#xff0c;英特尔的至强7400芯片面向虚拟服务器平台。在六核芯片上运行多个虚拟机会改进虚拟和…

【MQ】ActiveMQ(三)——spring管理ActiveMQ,实现发送和接收效果

一、前言 在前一篇博客中&#xff0c;小编向大家简单的介绍了一下ActiveMQ的消息处理方式&#xff0c;包括了点对点&#xff0c;发布订阅两种模式。写向大家展示了一下如何使用&#xff0c;但是在真正开发的时候我们是不会写那么一大片代码&#xff0c;从建立连接工厂&#xff…

浏览器掀起大战 奇虎360争夺最安全坐席

过去两周来&#xff0c;微软、Google两大国际巨头在浏览器上的较量格外令人瞩目&#xff1a;8月27日&#xff0c;微软浏览器Internet Explorer 8.0(IE8)测试版Ⅱ正式亮相微软官网&#xff1b;9月2日Google又在全球范围首次推出了Chrome浏览器测试版。不过&#xff0c;浏览器大战…

【MySql】Sql优化(一)——Sql执行流程

一、前言 前一段时间&#xff0c;公司的DBA离职了&#xff0c;这可怎么办呢&#xff0c;临危受命当起了DBA。当然也收到了一部分数据库设计文档&#xff0c;数据库ER图等。但是在后面的开发中&#xff0c;数据库也是随着需求修改&#xff0c;到下面的时候&#xff0c;需要进行S…

百度C2C支付平台定名百付宝 上线进入倒计时

淘宝屏蔽 百度搜索之后&#xff0c;百度的电子商务平台也动作频频。昨天&#xff0c;继百度称将向淘宝商户推出绿色通道之后&#xff0c;还宣布推出了 C2C支付平台 “百付宝”&#xff0c;而其电子商务平台的上线也进入倒计时。百度电子商务事业部一位人士告诉《第一财经日报》…

【MySql】Sql优化(二)——影响性能的因素

一、前言 在上一篇博客中&#xff0c;小编向大家简单介绍了一下Mysql执行的流程&#xff1a;客户端发送一条查询给数据库服务器&#xff0c;服务器先进行权限检测&#xff0c;然后在缓存中查询&#xff0c;如果命中了缓存&#xff0c;就立即返回存储在缓存中的结果&#xff0c;…