标签：baidu 请求 接口 api https com drf

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

前后端开发模式

1.前后端混合

2.前后端分离

前端的后台管理模板：
layui + jquery        国人研发
admin-lte 		老外

前后端混合

模板，使用模板语法渲染模板
--------------------------------------------------------
图书管理系统
BBS项目
--------------------------------------------------------
后端人员要通过前端写好的html页面，套模板语法

![前后端不分离]

后端分离

后面的项目
后端人员只负责写接口(API接口)，使用postman接口测试工具测试
前端人员负责写前端，写的过程中使用mock数据
最后：前后都端联调项目

![前后端分离]

API接口

通过网络规定了前后台信息交互的url链接，也是前后台交互的媒介
bbs中，点赞点踩就是一个api接口

四大特点

web API接口简单概括下面有四大特点

1. url:长的像返回数据的url链接
https://api.map.baidu.com/place/v2/search

2.请求方式： get ,post,put,patch delete
采用get方式请求上方接口

3.请求参数：json 或者xml格式的key-value类型数据
ak：6E823f587c95f0148c19993539b99295
region：上海
query：肯德基
output：json

4.响应结果：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

post man是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，

是测试接口的首选工具。
Postman可以直接从官网下载
https://www.postman.com/downloads/

简易的get请求

post请求

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

restful规范

REST全称是Representational State Transfer

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

规范10点

1.数据的安全保障

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

2.接口特征表现

注看到api字眼，就代表该请求url链接是完全前后台数据交互的
----------------------------------------------------------------------
https://api.baidu.com
https://www.baidu.com/api

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

响应状态码	作用
1xx	表示请求正在处理，一般看不到
2xx	表示请求处理成功
3xx	重定向302 301
4xx	客户端错误 403 404
5xx	服务端错误

8.错误处理，返回错误信息·，error当作key

返回错误信息--->响应体中带错误信息
		{code:100,msg:成功}
-------------------------------------------------
{
    error: "无权限操作"
}
---------------------------------------------------

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

GET /collection: 返回资源对象的列表（数组）
GET /collection/resource: 返回单个资源对象、
POST /collection: 返回新生成的资源对象
PUT /collection: 返回完整的资源对象
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接口开发，最核心常见的一个过程就是序列化，所谓序列化

序列化

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

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

反序列化

把别人提供的数据转换成我们需要的格式

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

Drf快速使用

安装drf

pip3 install djangorestframework

使用django web框架，开发前后端分离项目(模板渲染)只写接口

使用jsonResponse返回即可-->原生django
djangorestframework 方便咱们快速写出符合restful规范的接口
----------------------------------------------------------------------------

五个接口

总共就五个接口，以及这五个的变形

1.获取所有     -get
2.获取单个     -get
3.新增一条     -post
4.修改一条      -put/patch
5.删除一条      -delete

对于book表，快速实现这五个接口

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，都写基于类的试图

# cbv写好后，路由配置如下
	-第一个参数是路径，第二个参数是试图函数的内存地址（视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址）
	path('test/', views.TestView.as_view()),
    
    -去找as_view，去TestView类中找，找不到，没有，去父类中找View
        @classonlymethod
        def as_view(cls, **initkwargs):
            def view(request, *args, **kwargs):
                return self.dispatch(request, *args, **kwargs)
            return view
    -当请求来了，路由匹配成功，会执行view(request)--->本质执行self.dispatch(request, *args, **kwargs)
    -去View中找到了dispatch
        def dispatch(self, request, *args, **kwargs):
            # 请求方式转成小写，假设 get 请求，符合if条件
            if request.method.lower() in self.http_method_names:
                # 反射 getattr(对象,'字符串','默认值')
                # self是TestView的对象
                # handler 就是TestView类的get方法
                handler = getattr(self, 'get', self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
            return handler(request, *args, **kwargs)  # get(request)

标签：baidu,请求,接口,api,https,com,drf
From： https://www.cnblogs.com/zongliang-ya/p/16724471.html