前言
前后端分离开发已成为主流,专业人做专业事,明确各自的分工有利于提高工作效率。然而实际开发过程中,却受到一些因素的影响。比如接口代码不规范、后端接口不自测、前端传参错误、后端返参问题等等,往往耗费了大量的时间在接口联调上,导致工作效率比较低下。有没有好的方式去提高效率呢,下面就来说说编写restful风格API和swagger接口调用
restful风格接口
简介
Restful风格API是一种软件架构、设计风格,不是标准,只提供一组设计原则和约束条件。用于客户端与服务器进行交互。基于该风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。
在Restful风格中,用户请求的url使用同一个url而用请求方式:get、post、delete、put方式对请求的处理方法进行区分,这样可以在前后台分离式的开发中使得前端开发人员不会对请求的资源地址产生混淆和大量的检查方法名的麻烦,形成一个统一的接口。
非Restful风格弊端
1、大量方法名,多个开发项目命名混乱
2、GET和POST请求方法使用混乱,有些方法不声明具体方式,有时请求会报错
3、不够简洁,每个接口都需要命名且不能复用
实现方式
SpringMVC的resturl是通过
RequestMapping及PathVariableannotation提供的,通过如RequestMapping(value=”/blog/{id}”,method=RequestMethod.DELETE)即可处理/blog/1的delete请求。
GET(查询):从服务器查询,可以在服务器通过请求的参数区分查询的方式。
POST(创建):在服务器端新建一个资源,调用insert操作。
PUT(更新):在服务器端更新资源,调用update操作。
PATCH(更新):在服务器端更新资源(客户端提供改变的属性),很少使用
DELETE(删除):从服务器端删除资源,调用delete语句。
示例代码
入参示例
GET请求