当前位置: 首页 > news >正文

还不懂 RESTful 接口是什么?快进来看看

RESTful是指基于REST(Representational State Transfer,表现层状态转移)架构风格的Web服务。REST是一种设计原则和架构风格,而不是标准,它用于指导如何构建易于交互、高效、可扩展的网络系统。RESTful服务通常使用HTTP协议的标准方法来处理网络上的资源。

在现今互联网时代,Web服务已经成为了连接不同系统、平台和设备的关键桥梁。而RESTful架构风格作为一种简单而强大的设计理念,正在逐渐成为构建这些Web服务的首选方式,在做接口测试时,大家都有听说过RESTful风格的接口,那么到底什么是RESTful,以及它有哪些设计原则?

什么是RESTful?

"REST"(Representational State Transfer,表现层状态转移)是一种设计原则和架构风格,用于构建分布式系统,强调使用统一的接口和无状态通信来操作网络上的资源,"RESTful"则是基于REST原则设计的Web服务,使用HTTP协议的标准方法来实现对网络资源的操作。

1、每一个URI代表一种资源

在RESTful中,资源是系统中的任何实体或对象,每个资源都有一个唯一的URI来标识

  • json格式数据

  • text文本

  • 图片、视频等

2、资源的表示形式

客户端和服务器之间,传递资源的某种表现形式

  • 通过请求头中Content-Type来指明传给服务端的参数类型

  1. “text/plain”, “application/xml”, “text/html”,

  2. “application/json”, “image/gif”, “image/jpeg”

  3. "application/x-www-form-urlencoded"

AI写代码

  • 通过请求头中Accept来指明希望接受服务端的数据类型

Accept: application/json,application/xml;q=0.9,*/*;q=0.8
3、通过HTTP动词(请求方法)描述操作

客户端通过HTTP动词,指明对服务器端资源要进行的操作,包括GET/POST/PUT/PATCH/DELETE等

请求方法对应的操作
POSTCreate-创建
GETRead-查询
PUTUpdate/Replace-更新/替换
PATCHPartial Update/Modify-部分更新/替换
DELETEDelete-删除

RESTful设计规则

URL设计
1、URI命名

尽量使用名词复数形式,不要使用getXXX,setXXX这种动词和名词混合在一起

差的设计:

  1. /getProjects

  2. /listUsers

  3. /users

  4. /setTestcaseById?Id=66

好的设计:

  1. /projects

  2. /users

2、过滤条件

比如/projects返回项目信息,如果项目信息过多,服务端不可能将所有的数据全部返回给前端,一般我们会加上过滤条件​​​​​​​

  1. ?limit=10 :指定返回记录的数量

  2. ?offset=10 :指定返回记录的开始位置

  3. ?page=2&size=10 :指定第几页和每页的数据条数

  4. ?sort=name :指定返回结果按照哪个属性排序,以及排序顺序

3、API版本

在URL中呈现版本号:

  1. http://api.lemon.site/app/0.1/

  2. http://api.lemon.site/app/0.2/

  3. http://api.lemon.site/app/1.1/

也可在请求头中呈现:​​​​​​​

  1. Accept: application/vnd.example.v0.2+json

  2. Accept: application/vnd.example+json;version=1.1

请求方法

常见的HTTP请求方法有下面四个(括号里是对应的SQL命令)​​​​​​​

  1. GET(SELECT) :从服务器获取资源(一项或多项)

  2. POST(CREATE) :在服务器新建一个资源

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

  4. DELETE(DELETE) :从服务器删除资源

还有三个不常用的HTTP动词:​​​​​​​

  1. PATCH(UPDATE WHERE) :在服务器部分更新(更新)资源(客户端提供改变的属性)

  2. HEAD :获取资源的元数据

  3. OPTIONS :获取关于资源的哪些属性是客户端可以改变的信息

比如:​​​​​​​

  1. GET /projects # 获取所有项目信息

  2. POST /projects # 创建一个新项目

  3. GET /projects/6 # 获取ID为6的项目信息

  4. PUT /projects/6 # 更新ID为6的项目信息(全更新)

  5. PATCH /projects/6 # 更新ID为6的项目信息(部分更新)

  6. DELETE /projects/6 # 删除ID为6的项目

  7. GET /projects/6/interfaces # 获取ID为6的项目信息中所有的接口信息

  8. GET /projects/6/interfaces/1 # 获取ID为6的项目信息中ID为1的接口信息

状态码​​​​​​​
  1. 200 OK - [GET]:服务器成功返回用户请求的数据

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

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

  4. 400 INVALID REQUEST - [POST/PUT/PATCH]:用户请求有误(请求参数有误)

  5. 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)

  6. 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的

  7. 404 NOT FOUND - [*]:用户请求的路径不存在

  8. 500 INTERNAL SERVER ERROR - [*]:服务器发生错误

感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取

http://www.cnnetsun.cn/news/40522.html

相关文章:

  • 2026老年春晚怀化区域节目征集启动仪式在怀化学院举行
  • 【笔记篇】【硬件基础篇】电力电子元器件应用手册 阅读笔记(1)电阻器及其应用
  • 柠檬 软件测试之python全栈自动化测试工程师第25期
  • 为什么你的视觉AI项目总是耗时又低效?Florence-2-large-ft一站式解决方案
  • 基于php的微信小程序的学习交流平台系统(源码+lw+部署文档+讲解等)
  • springboot高校读书分享系统的设计与实现_34ur7fyk-
  • 如何快速解锁RouterOS无限权限:MikroTikPatch的终极指南
  • 测试工程师的增值型职业休假策略:从技术深耕到跨界突破
  • USART串口
  • SDET职业生涯中的关键决策点与路径选择
  • 第三方API密集型聚合服务的测试体系构建
  • System Informer:你的Windows系统管家,3大核心功能深度解析
  • 探索城市脉搏:解密共享单车数据背后的故事
  • 如何用abogen构建高质量有声书生成系统:从单文件到批量处理的完整指南
  • FastText实战进阶:解锁文本处理的极致性能与多场景应用
  • 车载功能测试都要做什么?总结来了~
  • 终极指南:掌握CogVLM多模态大模型核心技术
  • 【毕业设计/课程设计】基于Python的热门微博数据可视化分析源码+论文+PPT+数据
  • 监控选购全攻略:6大场景首选品牌,海康威视/格行视精灵各有侧重,小米性价比,萤石更全能;格行视精灵AOV技术+终生免流真好用?
  • 5步掌握Three.js延迟渲染技术:从多光源卡顿到流畅渲染的终极指南
  • Profinet转ModbusTCP网关:实现西门子1200PLC与打标卡稳定通讯
  • 工业设备实现全远程化运维的意义在哪
  • Signal-Android终极优化指南:7步实现APK大小缩减50%
  • TUnit集成WireMock:构建稳定可靠的.NET测试体系
  • 2025三季度报告出炉,平安银行存款平稳运行付息率降本增效
  • 掌握问题解决的艺术:波利亚《怎样解题》思维训练指南
  • 终极指南:如何快速上手MDPI Electronics论文LaTeX模板?
  • 已验证!零基础转行网络安全,我亲身实践的半年高效学习路线与复盘
  • 想从零转行网络安全?这是给你的入门指南与必须知道的避坑要点
  • High Performance Computing Center North(HPC2N),瑞典超算中心