还不懂 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来指明传给服务端的参数类型

“text/plain”, “application/xml”, “text/html”, “application/json”, “image/gif”, “image/jpeg”"application/x-www-form-urlencoded"

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

Accept: application/json,application/xml;q=0.9,*/*;q=0.8

3、通过HTTP动词（请求方法）描述操作

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

请求方法	对应的操作
POST	Create-创建
GET	Read-查询
PUT	Update/Replace-更新/替换
PATCH	Partial Update/Modify-部分更新/替换
DELETE	Delete-删除

RESTful设计规则

URL设计

1、URI命名

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

差的设计：

/getProjects/listUsers/users/setTestcaseById?Id=66

好的设计：​​​​​​​

/projects/users

2、过滤条件

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

?limit=10    ：指定返回记录的数量?offset=10    ：指定返回记录的开始位置?page=2&size=10          ：指定第几页和每页的数据条数?sort=name    ：指定返回结果按照哪个属性排序，以及排序顺序

3、API版本

在URL中呈现版本号：​​​​​​​

http://api.lemon.site/app/0.1/http://api.lemon.site/app/0.2/http://api.lemon.site/app/1.1/

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

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

请求方法

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

GET（SELECT）    ：从服务器获取资源（一项或多项）POST（CREATE）    ：在服务器新建一个资源PUT（UPDATE）    ：在服务器更新资源（客户端提供改变后的完整资源）DELETE（DELETE）  ：从服务器删除资源

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

PATCH（UPDATE WHERE） ：在服务器部分更新(更新)资源（客户端提供改变的属性）HEAD          ：获取资源的元数据OPTIONS          ：获取关于资源的哪些属性是客户端可以改变的信息

比如：

​​​​​​​

GET /projects      # 获取所有项目信息POST /projects      # 创建一个新项目GET /projects/6      # 获取ID为6的项目信息PUT /projects/6      # 更新ID为6的项目信息(全更新)PATCH /projects/6    # 更新ID为6的项目信息(部分更新)DELETE /projects/6    # 删除ID为6的项目
GET /projects/6/interfaces  # 获取ID为6的项目信息中所有的接口信息GET /projects/6/interfaces/1  # 获取ID为6的项目信息中ID为1的接口信息

状态码

​​​​​​​

200 OK - [GET]：服务器成功返回用户请求的数据201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功204 NO CONTENT - [DELETE]：用户删除数据成功400 INVALID REQUEST - [POST/PUT/PATCH]：用户请求有误(请求参数有误)401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的404 NOT FOUND - [*]：用户请求的路径不存在500 INTERNAL SERVER ERROR - [*]：服务器发生错误