（九） Django Restful API（接口规范）

• RESTful是一种开发理念
  • 是一种设计风格
• 每一个url代表一种资源
  • json 格式数据
  • text 文本
  • 图片，视屏
• 客户端和服务器之间，传递这种资源的表现
  • 通过请求头中的 content-type 来指明传给服务端的参数类型
    text/plain ,application/json , application/xml, text/html,image/gif,
    text/jepg,application/x-www-form-urllencoded
• 通过Accept 指明希望获取的服务端数据类型
  application/json
  application/json
• 客户端通过Http动词（请求方式），指明对服务器端资源要进行的操作
  • post 创建
  • GET 读取
  • put 更新
  • delete 删除

设计规则

• 命名
  1.尽量使用名词复数形式
  2.与数据库表名对应
• 过滤条件

1. ？limit = 10 : 指定返回记录的数量
2. offset = 10  : 指定返回数据的开始位置
3. page=1&size=10 : 指定第几页和每页显示数量
4. sort=name : 指定返回结果按照那个顺序排序，以及排序顺序

• 域名使用专业域名
• 版本

  • 在url中显示

    
    image.png

  • 请求头中显示

    
    image.png

HTTP的请求动词

• 含义

  
  image.png

• 状态码

  
  image.png

• 返回结果

  
  image.png

• 错误结果

  
  image.png

• 超链接API

  
  image.png