第一篇：DRF之介绍与简单使用

目录

• 第一篇：DRF之介绍与简单使用
  • 一、web开发模式
    • 1、前后端不分离
    • 2、前后端分离
  • 二、api接口
  • 三、postman使用
  • 四、RESTful规范【重点】
  • 五、drf的安装和简单使用

一、web开发模式

1、前后端不分离

我们以前的django项目，html页面是在后端进行模板的渲染，之后再返回给前端一个完整的html页面。【js代码除外，需要在浏览器进行渲染，所以js代码中不建议使用模板语法】。具体的流程如下。

2、前后端分离

随着发展，前后端不分离的项目已经不能满足一些相应的要求，所以便有了前后端分离的设计模式。

后端程序员只需要专注于写后端接口，返回给前端json、xml格式的数据即可，前后端使用json、xml格式进行交互。

# xml格式

yangyi

# json
{"name":"yangyi"}


每门语言都有其web框架，返回其相应的页面。
# java ---> jsp
类似于 https://www.pearvideo.com/category_loading.jsp
# php
类似于 http://www.aa7a.cn/user.php
# python
类似于 http://www.aa7a.cn/user 【也可以.html，作成伪静态页面】

"""动静态页面区分"""
动态页面（查数据库的）
静态页面（静止的html）


二、api接口

为了达成统一，避免因为个人的习惯差异而引起的混乱，我们需要使用一种大家都约定俗成去遵循的接口实现规范，并且这种规范能够让后端写的接口，用途一目了然。

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

"""四大特性"""
1 url: 长得像返回数据的url连接
2 请求方式: get、post、put、patch、delete
3 请求参数: json或xml格式的key-value键值对
4 响应结果: json或xml格式的数据


我们使用下面的路径进行测试，做一个简单的案例。

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E6%BE%84%E5%9F%8E%E5%8E%BF&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json


当然，也可以返回xml格式的数据。

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E6%BE%84%E5%9F%8E%E5%8E%BF&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml


三、postman使用

简单来说，postman就是一个模拟发送http请求的工具。

我们将刚才使用的路径使用postman进行测试，效果如下。

具体方式如下。

解析json的网站

好了，我们接着简单看一下，请求头中的数据。

postman还支持批量导入和导入接口。

# 导出
Collections ---> Export
# 导入
Collections ---> import


post解析json格式时，中文不存在乱码问题。同时最新的postman也会出现"/"的重定向。

四、RESTful规范【重点】

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

"""10条规范"""
1 数据的安全保障：url链接一般都采用https协议进行传输 注：采用https协议，可以提高数据交互过程中的安全性。
2 接口特征表现，一看就知道是个api接口
- 用api关键字标识接口url：
- [https://api.baidu.com](https://api.baidu.com/)
- https://www.baidu.com/api
注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
-路飞的接口：https://api.luffycity.com/api/v1/course/free/
3 多数据版本共存
- 在url链接中标识数据版本
- https://api.baidu.com/v1
- https://api.baidu.com/v2
注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
4 数据即是资源，均使用名词（可复数）
- 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
- https://api.baidu.com/users
- https://api.baidu.com/books
- https://api.baidu.com/book
注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
- 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义
- https://api.baidu.com/place/search
- https://api.baidu.com/login
5 资源操作由请求方式决定（method）
- 操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
- https://api.baidu.com/books - get请求：获取所有书
- https://api.baidu.com/books/1 - get请求：获取主键为1的书
- https://api.baidu.com/books - post请求：新增一本书书
- https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
- https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
- https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6 过滤，通过在url上传参的形式传递搜索条件
- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
7 响应状态码
7.1 正常响应
- 响应状态码2xx
- 200：常规请求
- 201：创建成功
7.2 重定向响应
- 响应状态码3xx
- 301：永久重定向
- 302：暂时重定向
7.3 客户端异常
- 响应状态码4xx
- 403：请求无权限
- 404：请求路径不存在
- 405：请求方法不存在
7.4 服务器异常
- 响应状态码5xx
- 500：服务器异常
8 错误处理，应返回错误信息，error当做key
{
error: "无权限操作"
}
9 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
10 需要url请求的资源需要访问资源的请求链接
# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
"status": 0,
"msg": "ok",
"results":[
{
"name":"肯德基(罗餐厅)",
"img": "https://image.baidu.com/kfc/001.png"
}
...
]
}


五、drf的安装和简单使用

我们使用如下方式进行安装。

pip3 install djangorestframework==3.10.3