Django Rest Framework --- restful 规范

一、什么是RESTFUL

restful是一种规范,与技术无关,代表的是一种软件架构的风格。

二、RESTFUL API设计

  • API与用户的通信协议,总是使用HTTPS协议
  • 域名(两种格式)
    • https://api.example.com  尽量将API部署在专用域名(会存在跨域问题)
    • https://example.org/api/     API很简单(通常使用这种)
  • 版本(两种方式)
    • URL:如:https://api.example.com/v1/   v1便是版本号
    • 将版本号放在请求头中    在跨域时,可能会引发发送多次请求问题
  • 路径:网络上的任何东西都是资源,均使用名词表示(名词可以是复数)
    •   例:https://example.org/api/v1/books 
  • method: 通过请求的方式,来表示需要操作的方法
    • GET:从服务器中取出资源(一项或两项)
    • POST:在服务器中新建一个资源
    • PUT:在服务器中更新资源(客户端提供改变后的完整的资源)
    • PATCH:在服务器中更新资源(客户端提供改变的属性)
    • DELETE:从服务器中删除资源
  • 过滤:通过url上传参的形式传递搜索的条件
    • https://api.example.com/v1/zoos?limit=10:指定返回记录的数量
    • https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件
  • 状态码
    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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    

    1 开头:服务器正在处理
    2 开头:服务器处理成功
    3 开头:重定向
    4 开头:客户端错误
    5 开头:服务器错误

    
    更多看这里:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
  • 错误处理,应该返回错误信息,error当做key
  • 返回结果,针对不同的操作,服务器向用户返回的结果应该符合以下规范
    GET /collection:返回资源对象的列表(数组)
    GET /collection/resource:返回单个资源对象
    POST /collection:返回新生成的资源对象
    PUT /collection/resource:返回完整的资源对象
    PATCH /collection/resource:返回完整的资源对象
    DELETE /collection/resource:返回一个空文档
  • 返回结果中提供链接,连向其他API方法
原文地址:https://www.cnblogs.com/846617819qq/p/10594190.html