接口设计规范

疯狂热爱代码的00后
0 阅读3分钟

RESTful 接口设计规范

www.ruanyifeng.com/blog/2014/0…

  1. 新事物产生的时候 => 野蛮生长期
  2. 就是前端设备层出不穷（手机App、平板App、桌面电脑（浏览器）、其他专用设备......），那么网络应用程序，分为前端和后端两个部分。
  3. 协议 https
  4. 域名 example.org/api/
  5. 路径（Endpoint）不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

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

    6.6 还有两个不常用的HTTP动词。 6.6.1 HEAD：获取资源的元数据。 6.6.2 OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

    6.7 下面是一些例子。

        接口设计
    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：删除某个指定动物园的指定动物

  2. 过滤信息

    1. 其实就是过滤返回结果，下面是一些常见的参数。
        ?limit=10：指定返回记录的数量
    ?offset=10：指定返回记录的开始位置。
    ?page=2&per_page=100：指定第几页，以及每页的记录数。
    ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
    ?animal_type_id=1：指定筛选条件

  3. 状态码

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

  4. 错误处理 9.1 { code: code, data: data error: error }

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

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

  6. 其他

  7. API的身份认证应该使用OAuth 2.0框架。www.ruanyifeng.com/blog/2014/0…

avatar
文章
阅读
粉丝