专栏首页软件测试架构师俱乐部从0到1开发测试平台(五)RESTful API接口设计标准及规范

从0到1开发测试平台(五)RESTful API接口设计标准及规范

我们测试平台目前采用的是前后端分离架构,后端的接口一般都是采用的restful API接口设计标准及规范。这里就简单说下跟我们平台有关的resultful相关知识

一.版本

将版本信息放在URL中,如:

https://api.example.com/v1/

https://api.example.com/v2/

v1,v2代表不同数据版本的提现,前提是一种数据资源有多个版本

二.method请求方式

GET :从服务器取出资源(一项或多项)

POST :在服务器新建一个资源

PUT :在服务器更新资源(客户端提供改变后的完整资源)

PATCH :在服务器更新资源(客户端提供改变的属性)

DELETE :从服务器删除资源

应用场景:GET一般用于读取服务器资源,不改变服务器资源;POST一般用于插入数据,PUT一般用于更新数据,DELETE一般用于删除数据

三.过滤

通过在url上传参的形式传递搜索条件

https://api.example.com/v1/zoos?limit=10:指定返回记录的数量

https://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序

https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件

四.安全性和幂等性

安全性:不会改变资源状态,可以理解为只读的;

幂等性:执行1次和执行N次,对资源状态改变的效果是等价的

安全性和幂等性均不保证反复请求能拿到相同的response。以 DELETE 为例,第一次DELETE返回200表示删除成功,第二次返回404提示资源不存在,这是允许的。

安全性

幂等性

GET

POST

×

×

PUT

×

DELETE

×

五.状态码

200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。

201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。

202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)

204 NO CONTENT - [DELETE]:用户删除数据成功。

301:永久重定向

302:暂时重定向

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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

本文分享自微信公众号 - 软件测试架构师俱乐部(gh_03227f9a322f),作者:瑺圊樹

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-07-09

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 打开springboot的大门【一】

    小编为mac电脑,最后打开终端并输入 java -version,如果出现以下信息,则说明JDK安装成功

    cctester
  • 带你用java从0到1开发测试平台

    最近看大家开发测试平台热情很高,本系列就带大家从0到1开发测试平台,技术栈主要是springboot+vue element ui(单module单体应用无权限...

    cctester
  • 测试圈不可错过的区块链知识(一)【全网最新】

    提到区块链大家第一反应就是比特币,之所以有这个反应是因为比特币创造了很多财富自由的神话,小小的价格波动也长期霸占着热搜。

    cctester
  • 你确定你的MySQL足够安全吗?

    对于任何一种数据库来说,安全问题都是非常重要的。如果数据库出现安全漏洞,轻则数据被窃取,重则数据被破坏,这些后果对于一些重要的数据库都是非常严重的。下面来从操作...

    黄泽杰
  • 反思一次Exchange服务器运维故障

    公司Exchange邮件系统邮件流故障的故障发现、故障处理和故障修复的过程记录和总结反思。帮助自己总结经验和吸取教训,同时也作为一次反面教材让其他运维或管理员吸...

    迅达集团
  • API 调用次数限制实现

    在开发接口服务器的过程中,为了防止客户端对于接口的滥用,保护服务器的资源, 通常来说我们会对于服务器上的各种接口进行调用次数的限制。比如对于某个 用户,他在一个...

    马哥Python
  • 工具| Metasploit与OpenVAS的结合使用

    漏斗社区
  • 【腾讯云的1001种玩法】IIS7实现全站HTTPS访问

    通常情况下我们是用的都是http的路径,对于https的使用也很少,但是随着https的普及越来越多的域名访问需要用到https的,现在给大家一个教程关于对一个...

    CloudZ
  • sysfs_create_group创建sysfs接口

    在调试驱动,可能需要对驱动里的某些变量进行读写,或函数调用。可通过sysfs接口创建驱动对应的属性,使得可以在用户空间通过sysfs接口的show和store函...

    233333
  • 百度分享工具不支持htts的解决方法

    herve

扫码关注云+社区

领取腾讯云代金券