后端api规范说明文档

Posted 2021-10-26 du-jun

   我们此次后端api的实现主要是按照RESTful api规范来设计的，就是符合REST架构下设计api的规范。简单的来说REST结构就是：利用URL定位资源，用HTTP动词(GET,POST,PUT,DELETE)来描述相应操作。

       RESTful api主要的意义在于它可以让在不同形式的前端所接受到的用户请求能够统一的发送到一个后台并返回不同的前端。RESTful api是由后端SERVER实现并提供给前端来调用的一个接口。前端调用API来向后台发起HTTP请求，后台响应请求并将处理结构反馈给前端。所以说RESTful是典型的基于HTTP的协议。所以下面我们对RESTful api的设计原则与规范进行相应的说明：

 

https://blog.csdn.net/qq_31805915/article/details/79951929

一、协议

       API与用户的通信协议，总是使用HTTPs协议。

二、域名

   尽量将API部署在专用域名之下：

   例如https://api.jupiter.com

三、版本

   将我们API的版本号放入URL中：

   例如https://api.jupiter.com/v1/

四、路径

   路径又称"终点"（endpoint），表示API的具体网址。

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

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

          https://api.jupiter.com/zoo

          https://api.jupiter.com/animals

          https://api.jupiter.com/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：删除某个指定动物园的指定动物

六、过滤信息

   如果记录数量很多，服务器不可能都将它们返回给用户。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 的含义是相同的。

七、状态码

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

   详细的状态码列表可见这里。

八、错误处理

   如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

        例如：

1.  
   {
2.  
   error: "Invalid API key"
3.  
   }

九、返回结果

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

      GET /collection：返回资源对象的列表（数组）

      GET /collection/resource：返回单个资源对象

      POST /collection：返回新生成的资源对象

      PUT /collection/resource：返回完整的资源对象

      PATCH /collection/resource：返回完整的资源对象

      DELETE /collection/resource：返回一个空文档