Rest Framework设计规范

Rest Framework

   Rest Framework是先后端分离中用到的一种规范,它与框架自己无关,是一种软件架构风格,全称为Representational State Transfer前端

   Rest Framework最显著的特色就是将一切数据看做资源,同时对不一样的请求方式作出不一样的责任划分。这种结构理念也被称为面向资源架构。数据库

先后端分离

   不一样于先后端混合开发中的接口,API接口主要用于为页面提供数据。随着先后端分离概念的出现,现在这种设计模式已经是大势所趋,先后端进行分离开发互不影响,而前端请求为页面进行填充数据的接口则统称为API接口。json

   如下是先后端分离与混合开发的差别:后端

   先后端不分离:展现的页面由后端决定,页面上的数据由模板渲染而来。设计模式

 

   先后端分离:后端只返回页面须要的数据,再也不承担模板的渲染工做,先后端开发耦合度较低。api

API设计

   对于后端的API接口设计,应该遵循RESTful AIP规范。数组

  •    通讯协议上应该采用HTTPS协议,确保数据安全安全

  •    API的域名应该具备必定的辨识度,以下url示例:服务器

    https://api.example.com  # 以api开头
    https://example.org/api/  # 以api结束
  •    API中应当放入版本号,以下示例:架构

    https://api.example.com/v1/
    https://api.example.com/v2/
  •    API请求路径中只能含有名词,不该该含有动词。并且所用的名词每每与数据库的表格名对应,支持复数(极其重要),以下示例:

    https://api.example.com/v1/book # 表明所有的书籍
    https://api.example.com/v1/get_all_book # 不该该使用动词,这是错误的形式
  •    因为API不含有动词,因此咱们能够根据不一样的请求方式对处理逻辑进行划分,以下所示:

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

       下面是一些例子:

    GET /book:列出全部书籍
    POST /book:新建一本书籍
    GET /book/ID:获取某个指定书籍的信息
    PUT /book/ID:更新某个指定书籍的信息(提供该书籍的所有信息)
    PATCH /book/ID:更新某个指定书籍的信息(提供该书籍的部分信息)
    DELETE /book/ID:删除某本数据
    GET /book/ID/details:列出某本书籍的详细信息
    DELETE /zoos/ID/author/ID:删除某本指定书籍中的指定做者
  •    若是记录数量不少,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

       下面是一些常见的参数。

    ?limit=10:指定返回记录的数量
    ?offset=10:指定返回记录的开始位置。
    ?page=2&per_page=100:指定第几页,以及每页的记录数。
    ?sortby=name&order=asc:指定返回结果按照哪一个属性排序,以及排序顺序。
    ?animal_type_id=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 - [*]:服务器发生错误,用户将没法判断发出的请求是否成功。
  •    对于API的返回内容来讲,若是状态码是4xx,则应该在返回信息中添加error及详细的错误描述。

    {
        error: "Invalid API key"
    }
  •    对于API的返回结果来讲,应该针对不一样的请求操做,服务器向用户返回的结果需符合如下规范。

    GET /collection:返回资源对象的列表(数组)
    GET /collection/resource:返回单个资源对象
    POST /collection:返回新生成的资源对象
    PUT /collection/resource:返回完整的资源对象
    PATCH /collection/resource:返回完整的资源对象
    DELETE /collection/resource:返回一个空文档
  •    能够在返回的信息中添加连接,让用户知道及时不查看文档,下一步也能够作什么。

    {"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}
相关文章
相关标签/搜索