【一】DRF之入门

【一】Web应用模式

在开发Web应用中，有两种应用模式：

【1】前后端不分离

【2】前后端分离

【二】API接口

  • 为了在团队内部形成共识、防止个人习惯差异引起的混乱
  • 我们需要找到一种大家都觉得很好的接口实现规范
    • 而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。

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

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

    • url：长得像返回数据的url链接

    • 请求方式：get、post、put、patch、delete

      • 采用get方式请求上方接口

    • 请求参数：json或xml格式的key-value类型数据

      • ak：6E823f587c95f0148c19993539b99295
      • region：上海
      • query：肯德基
      • output：json

    • 响应结果：json或xml格式的数据

      • 上方请求参数的output参数值决定了响应数据的格式

      • 数据

        # xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
    "status":0,
  	"message":"ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

【三】接口测试工具：Postman

  • Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。

  • Postman可以直接从官网：https://www.getpostman.com/downloads/下载获得，然后进行傻瓜式安装。

  • 工作面板

  • 简易的get请求

  • 简易的post请求

  • 案例：请求百度地图接口

【四】RESTful API规范

  • REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。
    • 它首次出现在2000年Roy Fielding的博士论文中。
  • RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
  • 这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
  • 事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

【1】数据的安全保障

  • url链接一般都采用https协议进行传输

注：采用https协议，可以提高数据交互过程中的安全性

【2】接口特征表现

注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

【3】多数据版本共存

注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）

【4】数据即是资源，均使用名词（可复数）

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

【5】资源操作由请求方式决定（method）

【6】过滤

【7】响应状态码

（1）正常响应

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

（2）重定向响应

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

（3）客户端异常

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

（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"
        }
      	...
		]
}
  • 比较好的接口返回
// 响应数据要有状态码、状态信息以及数据本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

【五】序列化

  • api接口开发，最核心最常见的一个过程就是序列化
  • 所谓序列化就是把数据转换格式，序列化可以分两个阶段：

【1】序列化：

  • 把我们识别的数据转换成指定的格式提供给别人。

  • 例如：

    • 我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。

【2】反序列化：

  • 把别人提供的数据转换/还原成我们需要的格式。
  • 例如：
    • 前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
posted @ 2023-07-31 12:04  Chimengmeng  阅读(33)  评论(0)    收藏  举报