【Restful】你还不懂Restful API规范吗？

待我称王封你为后i 2022-09-04 06:48 160阅读 0赞

进入正文之前，先带着小伙伴们了解几个名词，源自百度百科。  
标题中涉及的核心名词**API**，**restful**

# 扩展 #

*  何为API呢？

**API**（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

*  何为restful呢？  
    **restful是一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件**。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

RESTful的关键是定义可表示流程元素/资源的对象。在REST中，每一个对象都是通过URL来表示的，对象用户负责将状态信息打包进每一条消息内，以便对象的处理总是无状态的。

# Restful API #

## 域名 ##

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

## 版本（Versioning） ##

应该将API的版本号放入URL。

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

## 路径 ##

路径又称"终点"（endpoint），表示API的具体网址。  
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

https://api.example.com/v1/zoos
    https://api.example.com/v1/animals
    https://api.example.com/v1/employees

## HTTP动词 ##

对于资源的具体操作类型，由HTTP动词表示。  
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

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

例如：

GET /zoos：列出所有动物园
    POST /zoos：新建一个动物园
    GET /zoos/ID：获取某个指定动物园的信息
    PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
    PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
    DELETE /zoos/ID：删除某个动物园
    GET /zoos/ID/animals：列出某个指定动物园的所有动物
    DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

## 过滤信息（Filtering） ##

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。  
下面是一些常见的参数。

?limit=10：指定返回记录的数量
    ?offset=10：指定返回记录的开始位置。
    ?page=2&per_page=100：指定第几页，以及每页的记录数。
    ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
    ?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo\_id=ID 的含义是相同的。

## 状态码（Status Codes） ##

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

## 返回结果 ##

针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
    GET /collection/resource：返回单个资源对象
    POST /collection：返回新生成的资源对象
    PUT /collection/resource：返回完整的资源对象
    PATCH /collection/resource：返回完整的资源对象
    DELETE /collection/resource：返回一个空文档

# 总结 #

了解上面API的理论知识之后，现在总结一下RestFulAPI规范，实际日常开发工作中主要从URL路径、HTTP请求动词、状态码和返回结果等方面详细考虑。

*  URL设计规范  
    URL为统一资源定位器 ,接口属于服务端资源，首先要通过URL这个定位到资源才能去访问，而通常一个完整的URL组成由以下几个部分构成：

URI = scheme "://" host  ":"  port "/" path [ "?" query ]

1.  scheme: 指底层用的协议，如http、https、ftp
2.  host: 服务器的IP地址或者域名
3.  port: 端口，http默认为80端口
4.  path: 访问资源的路径，就是各种web 框架中定义的route路由;  
    RESTful对path的设计做了一些规范，通常一个RESTful API的path组成如下：
    
        /{version}/{resources}/{resource_id}

*  version：API版本号，有些版本号放置在头信息中也可以，通过控制版本号有利于应用迭代。
 *  resources：资源，RESTful API推荐用小写英文单词的复数形式。
 *  resource\_id：资源的id，访问或操作该资源。

1.  query: 查询字符串，为发送给服务器的参数，在这里更多发送数据分页、排序等参数。

**对于RESTful API的URL具体设计的规范如下：  
1.不用大写字母，所有单词使用英文且小写。  
2.连字符用中杠"-“而不用下杠”\_"  
3.正确使用 “/“表示层级关系,URL的层级不要过深，并且越靠前的层级应该相对越稳定  
4.结尾不要包含正斜杠分隔符”/”  
5.URL中不出现动词，用请求方式表示动作  
6.资源表示用复数不要用单数  
7.不要使用文件扩展名**