关于RESTful一些注意事项,接口开发规范
前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家。点击跳转到教程。
最近在研究restful,公司开发要使用,所以自己就去网上找了好些资料,并整理了一套公司开发的接口规范。当然,我也只是刚刚入坑。还不是很全面。但是这就是一个过程。一点点,总会好起来的。以下是就是RESTful接口规范:
一、 URI
URI规范
1.不用大写;
2.用中杠 - 不用下杠 _ ;
3.参数列表要encode;
4.URI中的名词表示资源集合,使用复数形式。
5.在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词(特殊情况可以使用动词),而且所用的名词往往与数据库的表格名对应。
资源集合 vs单个资源
URI表示资源的两种方式:资源集合、单个资源。
资源集合:
/zoos //所有动物园
/zoos/1/animals //id为1的动物园中的所有动物
单个资源:
/zoos/1//id为1的动物园
/zoos/1;2;3//id为1,2,3的动物园
避免层级过深的URI
在url中表达层级,用于 按实体关联关系进行对象导航 ,一般根据id导航。
过深的导航容易导致url膨胀,不易维护,如 GET /zoos/1/areas/3/animals/4 ,尽量使用查询参数代替路径中的实体导航,如 GET/animals?zoo=1&area=3 ;
二、 版本
应该将API的版本号放入到URI中
https://api.example.com/v1/zoos
三、 Request
HTTP方法
通过标准HTTP方法对资源CRUD:
GET:查询(从服务器取出资源一项或多项)
GET /zoos
GET /zoos/1
GET/zoos/1/employees
POST:创建单个新资源。 POST一般向“资源集合”型uri发起
POST/animals //新增动物
POST/zoos/1/employees //为id为1的动物园雇佣员工
PUT:更新单个资源(全量),客户端提供完整的更新后的资源。与之对应的是 PATCH,PATCH负责部分更新,客户端提供要更新的那些字段。 PUT/PATCH一般向“单个资源”型uri发起
PUT/animals/1
PUT /zoos/1
DELETE:删除
DELETE/zoos/1/employees/2
DELETE/zoos/1/employees/2;4;5
DELETE/zoos/1/animals //删除id为1的动物园内的所有动物
HEAD / OPTION/ PATCH用的不多,就不多解释了。
HEAD:获取资源的元数据
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的
PATCH:在服务器更新资源(客户端提供改变的属性)
安全性和幂等性
1. 安全性 :不会改变资源状态,可以理解为只读的;
2. 幂等性 :执行1次和执行N次,对资源状态改变的效果是等价的。
. |
安全性 |
幂等性 |
GET |
√ |
√ |
POST |
× |
× |
PUT |
× |
√ |
DELETE |
× |
√ |
安全性和幂等性均不保证反复请求能拿到相同的response。以 DELETE为例,第一次DELETE返回200表示删除成功,第二次返回404提示资源不存在,这是允许的。
复杂查询
查询可以捎带以下参数:
. |
示例 |
备注 |
过滤条件 |
?type=1&age=16 |
允许一定的uri冗余,如 /zoos/1 与 /zoos?id=1 |
排序 |
?sort=age&order=asc |
指定返回结果按照哪个属性排序,以及排序顺序 |
投影 |
?whitelist=id,name,email |
|
分页 |
? page=2&per_page=100 |
指定第几页,以及每页的记录数 |
Bookmarker
经常使用的、复杂的查询标签化,降低维护成本。
如:GET /trades?status=closed&sort=created,desc
快捷方式:GET /trades#recently-closed或者GET /trades/recently-closed
状态码
服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
§200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
§201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
§202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
§204 NO CONTENT - [DELETE]:用户删除数据成功。
§400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
§401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
§403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
§404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
§406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
§410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
§422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
§500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
状态码的完全列表参见这里
URI失效
随着系统发展,总有一些API失效或者迁移,对失效的API,返回404 not found 或 410 gone;对迁移的API,返回 301重定向。
四、Response
1. 不要包装:
response的 body 直接就是数据,不要做多余的包装。错误示例:
{
"success":true,
"data":{"id":1,"name":"xiaotuan"},
}
2. 各HTTP方法成功处理后的数据格式:
· |
response 格式 |
GET |
单个对象、集合 |
POST |
新增成功的对象 |
PUT/PATCH |
更新成功的对象 |
DELETE |
空 |
五、错误处理
1. 不要发生了错误但给2xx响应,客户端可能会缓存成功的http请求;
2. 正确设置http状态码,不要自定义;
3. Response body提供
即:返回的信息中将error作为键名,出错信息作为键值即可
1)错误的代码(日志/问题追查);
2)错误的描述文本(展示给用户)。
对第三点的实现稍微多说一点:
Java服务器端一般用异常表示 RESTful API的错误。API 可能抛出两类异常:业务异常和非业务异常。 业务异常 由自己的业务代码抛出,表示一个用例的前置条件不满足、业务规则冲突等,比如参数校验不通过、权限校验失败。 非业务类异常 表示不在预期内的问题,通常由类库、框架抛出,或由于自己的代码逻辑错误导致,比如数据库连接失败、空指针异常、除0错误等等。
业务类异常必须提供2种信息:
1. 如果抛出该类异常,HTTP响应状态码应该设成什么;
2. 异常的文本描述;
在Controller层使用统一的异常拦截器:
1. 设置 HTTP响应状态码:对业务类异常,用它指定的 HTTPcode;对非业务类异常,统一500;
2. Response Body的错误码:异常类名
3. Response Body的错误描述:对业务类异常,用它指定的错误文本;对非业务类异常,线上可以统一文案如“服务器端错误,请稍后再试”,开发或测试环境中用异常的 stacktrace,服务器端提供该行为的开关。
常用的http状态码及使用场景:
状态码 |
使用场景 |
400 bad request |
常用在参数校验 |
401 unauthorized |
未经验证的用户,常见于未登录。如果经过验证后依然没权限,应该 403(即 authentication和authorization的区别)。 |
403 forbidden |
无权限 |
404 not found |
资源不存在 |
500 internal server error |
非业务类异常 |
503 service unavaliable |
由容器抛出,自己的代码不要抛这个异常 |
六、其他
(1)API的身份认证应该使用OAuth2.0框架
(2)服务器返回的数据格式,应该尽量使用JSON,避免使用XML
(3)比较复杂的接口不能确定是使用POST还是PUT时,要看具体的业务层代码,看看接口产生的结果是否幂等,如果幂等用PUT,相反用POST
如:接口接收到一资源,资源存在更新,不存在插入新数据,这个接口就要用PUT
关于RESTful一些注意事项,接口开发规范相关推荐
- 接口开发规范 restful接口开发规范
2019独角兽企业重金招聘Python工程师标准>>> 1. Api请求及响应规范 为了严格按照接口进行开发,提高效率,对请求及响应格式进行规范化. 1.get 请求时,采用key/ ...
- java接口开发规范,干货满满
第一个模块:数据库 1.1 腾讯数据库面试问题 解释ACID四大特性 原子性的底层实现 数据库宕机后恢复的过程 如何保证事务的ACID特性 MySQL日志类型 这5个题目相对来说是比较普遍的,这里我就 ...
- Java 项目 接口开发规范
API请求与响应规范 请求: get:采用key/value格式 1.@PathVariable 统一指定参数名称,如:@PathVariable("id") 2.@Request ...
- 学成在线--1.CMS接口开发
文章目录 0.定义CMS 1.CMS页面管理 2.需求分析 3.模型类介绍 4.定义请求及响应类型 5.定义接口 6.创建CMS工程结构 7.Dao 1)创建Dao,继承MongoRepository ...
- java restful接口开发实例_实战:基于Spring Boot快速开发RESTful风格API接口
写在前面的话 这篇文章计划是在过年期间完成的,示例代码都写好了,结果亲戚来我家做客,文章没来得及写.已经很久没有更新文章了,小伙伴们,有没有想我啊.言归正传,下面开始,今天的话题. 目标 写一套符合规 ...
- Java开发规范及注意事项
文章目录 Java开发规范及注意事项 编程规约 异常日志违约 单元测试规约 工程结构规约 数据库规约 Java开发规范及注意事项 编程规约 POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解 ...
- PHP 接口开发注意事项
PHP 接口开发注意事项 PHP 接口开发注意事项 预先定义接口流程和逻辑,确认需求 在开发前首先确定流程,复杂的接口可以绘制流程图,并确保流程与需求一致: 使用统一的变量定义 无论是SDK还是Ser ...
- restful接口开发实例_Restful接口开发与测试—接口测试
开发完接口,接下来我们需要对我们开发的接口进行测试.接口测试的方法比较多,使用接口工具或者Python来测试都可以,工具方面比如之前我们学习过的Postman或者Jmeter ,Python脚本测试可 ...
- Android接口一般定义格式,Android开发规范
原标题:Android开发规范 一.书写规范 1. 编码方式统一用UTF-8. 2. 花括号不要单独一行,和它前面的代码同一行.而且,花括号与前面的代码之间用一个空格隔开. 3. 空格的使用 if.e ...
最新文章
- Pycharm 修改tab缩进快捷键
- caffe卷积层代码阅读笔记
- 11.11.25 v2 done
- Javascript中char和int的互相转换的代码(转载)
- python在文件中写入字典_python初学--文件操作、字典
- 《深入浅出深度学习:原理剖析与python实践》第八章前馈神经网络(笔记)
- 【概率论】复习资料(手写复习)
- pxe启动找不到服务器,linux – PXE启动 – 在TFTP服务器上找不到内核
- Android控件 TabHost,Android控件之TabHost用法实例分析
- 数据库中的超键 候选键 主键 外键
- 教你如何在短期内做好会员运营快速拉新用户
- 微信小程序内置在线客服
- 如何在多个iOSapp里共享数据
- 广义SAM(SAM套trie)
- Canonical Coordinate System
- linux在双系统中消失了,win和linux双系统下,重装win系统导致linux系统消失的解决办法...
- Codeforces Round #643 (Div. 2)——B. Young Explorers
- 弘辽科技:拼多多类目选错了有什么影响?怎么办?
- 正文样式设置必看:你知道最好不要直接在正文样式中设置首行缩进吗
- Karto Slam 参数配置
热门文章
- 【JS 逆向百例】某易支付密码 MD5+AES 加密分析
- 【Python 必会技巧】lambda 表达式(匿名函数)及其在内置函数中的应用
- element.style内联样式修改
- 简易有WEB文件服务器,Python实现简易版的Web服务器(推荐).pdf
- linux shell跳板机,用shell开发跳板机
- 【CF#148B】Escape(模拟)
- Apollo进阶课程㉖丨Apollo规划技术详解——Understand More on the MP Difficulty
- java 反射 代码_java反射机制学习代码
- python中with open写csv文件_Python中的CSV文件使用with语句的方式详解
- mysql atlas更新问题_Atlas几种常见故障解决(不定期更新)