Question

RESTfulAPI风格

Answer 1

在进行API接口设计时，不同的开发人员可能有不同的设计风格，风格迥异。

那是否存在一种统一的接口设计方式，被广大开发人员所接受呢？

答: 这就是被普遍采用的RESTful API设计风格 。

路径又称"终点"（endpoint），表示API的具体网址，每个网址代表一种资源（resource）。

（1）URL地址尽量使用名词，不使用动词。

举例来说，以下是不好的例子:

对于一个简洁结构，应该始终用名词。

（2） API中的名词应该使用复数，无论单个资源或者所有资源 。

举例来说，获取产品的API可以这样定义：

访问同一个URL地址，采用不同的请求方式，代表要执行不同的操作 。

常用的HTTP请求方式有下面四个：

例如：

过滤参数可以放在查询字符串中 。

在访问API接口获取数据时，可能需要对数据进行过滤。

下面是一些常见的参数：

针对不同操作，服务器向用户返回的响应数据应该符合以下规范：

服务器返回的响应数据格式，应该尽量使用JSON。

服务器向客户端返回的状态码和提示信息，常见的状态码如下：