第九章：restfull规范

一、申明

所谓的restfull规范不是技术,也不是非必须的,不使用也可以的.只是行业很多人用这个,既然大家都用这个,那么在实际的开发过程中更好的交流,约定大于配置可能就是这样的原理.

二、restfull规范

  • 1、API与用户的通信协议,总是使用HTTPS协议
  • 2、域名
    • https://api.example.com 会存在跨域的问题
    • https://example/com/api 简单明了
  • 3、必须标注版本
    • https://example/com/api/v1 表示版本1
    • 也可以在请求头里面设置
  • 4、路径，视网络上任何东西都是资源，均使用名词表示（可复数),不要使用动词(比如: getXX,putXXX...)

  • 5、请求方式method

    • get:从服务器端取资源(可以一条数据也可以是多条数据)
    • post:在服务器端新建一个资源
    • put: 在服务器端更新资源(全部更新)
    • patch:在服务器端更新资源(局部更新)
    • delete:从服务器端删除资源

  • 6、过滤，通过在url上传参的形式传递搜索条件

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

  • 7、状态码

    • 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

  • 8、错误处理

    {
    error: "错误提示"
}

  • 9、返回结果,针对不同操作,服务器端返回数据结构有不同的规范

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

  • 10、Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

    {"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

results matching ""

    No results matching ""