RESTful规范

  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture

RESTful API设计

  • 协议

    • http
    • https

  • 域名

    • https://api.example.com  # 存在跨域问题

    • www.example.com/api

  • 版本

    • URL，如：https://api.example.com/v1/
    • 请求头      跨域时，引发发送多次请求

  • 路由

    • https://api.example.com/list/  数据的集合
    • https://api.example.com/list/1/ 单条数据

  • 请求方法

    • GET      ：从服务器取出资源（一项或多项）
    • POST    ：在服务器新建一个资源
    • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
    • PATCH  ：在服务器更新资源（客户端提供改变的属性）
    • DELETE ：从服务器删除资源

  • 条件

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

  • 状态码

  • 返回值

    • 针对不同操作，服务器向用户返回的结果应该符合以下规范。 
      GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
  • 错误处理
    • 应返回错误信息，error当做key
  • Hypermedia API
    • RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

 Django中的rest_framework框架

自己通过CBV的方式去实现restful接口是非常麻烦的,其中请求数据(非GET,POST)的获取,以及获取数据的序列化都需要自己去完成,

而rest_framework提供了解析器和序列化功能,

posted @ 2018-04-12 19:59  瓜田月夜  阅读(74)  评论(0)  编辑  收藏  举报