接口规范

什么是Web API接口

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点

• url：长得像返回数据的url链接
  • https://api.map.baidu.com/
• 请求方式：get、post、put、patch、delete
  • 采用get方式请求上方接口
• 请求参数：json或xml格式的key-value类型数据
• 响应结果：json或xml格式的数据

Restful 接口规范

简介

2000年Roy Fielding博士在其博士论文中提出REST（Representational State Transfer）风格的软件架构模式后，REST就基本上迅速取代了复杂而笨重的SOAP，成为Web API的标准了。

RESTful作为目前最流行的 API 设计规范，一定有着它独有的魅力：强大、简介、易上手。让我们接口开发起来更加简洁。

URL设计

数据的安全保障

• url链接一般都采用https协议进行传输，可以提高数据交互过程中的安全性。

接口特征表现

• 用api关键字标识接口url：https://api.baidu.com

数据即是资源

• 接口一般都是完成前后端数据的交互，交互的数据我们称之为资源

  注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user

资源操作由请求方式决定

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供完整资源数据）。
• PATCH（UPDATE）：在服务器更新资源（客户端提供需要修改的资源数据）。
• DELETE（DELETE）：从服务器删除资源。

响应状态码

正常响应

• 响应状态码2xx
  • 200：常规请求
  • 201：创建成功

重定向响应

• 响应状态码3xx
  • 301：永久重定向
  • 302：暂时重定向

客户端异常

• 响应状态码4xx
  • 403：请求无权限
  • 404：请求路径不存在
  • 405：请求方法不存在

服务器异常

• 响应状态码5xx
  • 500：服务器异常

drf安装与使用

"""
安装drf：pip3 install djangorestframework
settings.py注册app：===> 'rest_framework'
基于cbv完成满足RESTful规范的接口
"""