drf

Web API接口

通过web请求,访问前后端交互的url连接,就是web api.

web api接口的四大特点

• url:长得像url,即由4部分组成：协议、主机、端口、路径组成
• 请求方式:get|post|put|patch|delete
• 请求参数:json或者xml格式的key-value类型数据
• 响应结果:json或者xml格式的数据

接口文档的编写

YApi,去哪儿网发布的开源可视化接口管理平台.

http://yapi.demo.qunar.com/

接口测试工具

Postman

一款免费可视化接口调试工具.

https://www.getpostman.com/

restful接口规范

2000年由Roy Fielding的博士论文中提出,全称Representational State Transfer,常常翻译为表征性状态转移.如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

设计规范

• 一般采用https协议进行传输

• 采用api关键字标识接口url

  • https://api.baidu.com

• 多版本共存使用v标识

  • https://api.baidu.com/v1
  • https://api.baidu.com/v2

• 数据即资源

  • 使用名词复数来表示

    https://api.baidu.com/books

  • 个别特殊可以使用动词表示

    https://api.baidu.com/place/search

• 五大请求方式

  • get:获取单个或多个值

    返回单个或多个结果对象

  • post:新增单个或多个值

    返回单个或多个结果对象

  • put:整体修改单个或多个值

    返回单个或多个结果对象

  • patch:局部修改单个或多个值

    返回值与put完全一致,

    区别:put操作5个key-value键值对,而patch提供的操作字典包含的键值对在0~5都可以

  • delete:删除单个或多个值

    不做资源返回,(一般会返回一个结果信息:成功|失败)

• 响应状态码

  1xx:基本信息

  2xx:成功 200基本 201新增成功

  3xx:重定向

  4xx:服务端错误 400错误请求 403请求无权限 404请求资源不存在

  5xx:服务端错误 500服务器错误

• 数据状态码

  0:成功

  1:失败 1xx:具体失败信息(需要在接口文档中明确写出)

  2:无数据 2xx:具体无数据信息(需要在接口文档中明确写出)

• 数据状态信息

  一般不仅仅是对数据状态码的解释,更多是对结果的描述,给前台开发者阅读

• 数据结果(常量,数组,字典)

  如果有子资源,返回资源的url链接

  {
      "status": 0,
      "msg": 'ok',
      "results": [{
          "name": "西游记",
          "img": "https://api.baidu.com/media/book/xyj.png"
      }]
  }
  

drf框架安装

drf框架安装

pip install djangorestframework