标签：baidu 请求 笔记 学习 api 接口 https com drf

今日内容概要

• 前后端开发模式
• API接口
• 接口测试工具postman
• restful规范
• 序列化和反序列化
• djangorestframework快速使用
• cbv源码分析

今日内容详细

前后端开发模式

前后端混合开发

既要写后端(django: python界的web框架),又要写前端(js, css, html + 模板语法(dtl))
例如：bbs项目和图书管理系统
写前后端混合项目：后端人员写后端+模板语法，前端人员写js,css,html

前后端分离

后端任人员只负责写接口(API接口)，使用postman接口测试工具测试
前端人员负责写前端，写的过程中使用mock数据

API接口

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

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

url：长得像返回数据的url链接
    https://api.map.baidu.com/place/v2/search
请求方式：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/下载获得，然后进行傻瓜式安装。

使用方法：

第一步：先点+号新增一个tab，然后输入接口地址，左边下拉框选择请求的方式，然后点击蓝色的Send进行请求的发送。

第二步：点击Body请求体，选择自己想要的编码格式，填写数据然后进行数据提交。

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

restful规范

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

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

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

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

restful规范有10条规范：

1.数据的安全保障

url链接一般都采用https协议进行传输(http+tsl/ssl=https)
采用https协议，可以提高数据交互过程中的安全性

2.接口特征表现

接口中带api关键词
例：https://www.baidu.com/api
看到api字眼，就代表该请求url链接是完成前后台数据交互的

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地址中带过滤参数

-获取动物园所有动物   127.0.0.1/api/v1/animals  --->get请求
-获取动物园所有哺乳类动物   127.0.0.1/api/v1/animals?type=哺乳类  --->get请求

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.响应带状态码

-http状态码：http://tools.jb51.net/table/http_status_code
-1xx：表示请求正在处理，一般看不到
-2xx： 表示请求处理成功
    200：常规请求
    201：创建成功
-3xx： 重定向
    301：永久重定向
    302：暂时重定向
-4xx： 客户端错误
    403：请求无权限
    404：请求路径不存在
    405：请求方法不存在
-5xx ：服务端错误 
-响应体中写状态码:咱们公司里有规范，在响应体中写状态码
    {code:100}

8.返回错误信息

响应体中带错误信息
{code:100, msg:成功}

9.返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范

GET /collection：返回资源对象的列表（数组）[{},{}]
GET /collection/resource：返回单个资源对象 {}
POST /collection：返回新生成的资源对象     {}
PUT /collection/resource：返回完整的资源对象 {}
PATCH /collection/resource：返回完整的资源对象 {}
DELETE /collection/resource：返回一个空文档

获取所有：{code:100,msg:成功,data:[{name:水浒传,price:99},{name:西游记,price:88}]}
获取单条：{code:100,msg:成功,data:{name:水浒传,price:99}}
新增数据：{code:100,msg:新增成功,data:{name:西游记,price:99}}
修改数据：{code:100,msg:修改成功,data:{name:西游记v2版本,price:99}}
删除数据：{code:100,msg:删除成功}

10.响应中带链接

序列化和反序列化

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

序列化：把我们认识的数据转换成指定的格式提供给别人。

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

反序列化：把别人提供的数据转换/还原成我们需要的格式。

例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。

djangorestframework快速使用

# 使用django这个web框架，开发前后端分离项目(模板渲染),只写接口
使用JsonResponse返回即可---》原生django
djangorestframework方便咱们快速写出符合restful规范的接口

# 写接口：总共就5个及这5个的变形
-获取所有 get
-获取单个 get
-新增一条 post
-修改一条 put/patch
-删除一条 delete

# 对于book表，快速实现这5个接口---》不需要你会
-使用drf有多块
-安装drf：pip3 install djangorestframework

urls.py

from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views


router = SimpleRouter()
router.register('books', views.BookView)
urlpatterns = [
    path('admin/', admin.site.urls),
]
urlpatterns += router.urls

views.py

from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer


class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

models.py

from django.db import models


class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)

serializer.py

from rest_framework import serializers
from .models import Book


class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

通过postman测试

cbv源码分析

cbv写好后，路由配置如下：

path('test/', views.TestView.as_view()),

第一个参数是路径，第二个参数是视图函数的内存地址(视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址)

首先去找as_view，去TestView类中找，找不到的话，去父类中找View，发现它返回的是view这个函数的内存地址。

@classonlymethod
def as_view(cls, **initkwargs):
    def view(request, *args, **kwargs)
        return self.dispatch(request, *args, **kwargs)
    return view

当请求来的时候，路由匹配成功，就会去执行as_view里的view函数。

# 本质执行self.dispatch(request, *args, **kwargs)
def view(request, *args, **kwargs)
    return self.dispatch(request, *args, **kwargs)

接着去View中找到了dispatch，而dispatch是CBV最精髓的部分，它的作用就是你是什么请求，就会执行视图类中请求名字的方法。

def dispatch(self, request, *args, **kwargs):
    # 请求方法变成小写字符串  ，如果是get请求，就是 'get'
    # self.http_method_names  列表 ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']
    if request.method.lower() in self.http_method_names:
        # 重点：反射  getattr(对象,'字符串','默认值')  去对象中，根据字符串，取出方法或属性
        # self是视图类的对象  handler就是你写在视图类中的get方法
        handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
    else:
        handler = self.http_method_not_allowed
    # 执行get方法  视图函数的get方法
    return handler(request, *args, **kwargs)

小结: 发送请求–>as_view()–>as_view中的view函数–>dispatch函数–>执行函数,返回结果。

标签：baidu,请求,笔记,学习,api,接口,https,com,drf
From： https://www.cnblogs.com/wwjjll/p/16723921.html