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

今日内容

前后端开发模式

补充知识

xml模式
	<xml>xxx</xml>
json模式
	{"name":"xxx"}
前端的后台管理模板:x-admin
	使用的是 layui+juqery
前端的后台管理模板:admin-lte
	使用的是 bootstrap+juaery

-前后端混合开发--->模板使用模板语法渲染模板

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

前后端分离

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

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)

API接口写好后端人员要测试不可能在浏览器里测试

使用postman软件来做接口测试

官网下载：https://www.postman.com/

restful规范

REST全称是Representational State Transfer，中文意思是表述:表征性状态转移, 它首次出现在2000年Roy Fielding的博士论文中

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

restful规范有10点但公司都会有自己的风格规范

1.数据安全的保障

url链接一般都采用https协议进行传输
为了保证数据的安全使用
https是什么
	http+ssl/tsl

2.接口特征表现

用api关键字标识接口url
	https://api.baidu.com
	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)

操作资源一般都会涉及到增删改查 我们提供请求方式来标识增删改查动作
	获取数据:get请求
	删除数据:delete请求
	新增数据:post请求
	修改数据:put,patch请求
请求地址一样，通过请求方式决定对资源进行什么操作
eg:
	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:请求路径不存在
	404:请求方法不存在

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"
        }
      	...
		]
	}

比较好的接口返回

响应数据要有状态码、状态信息以及数据本身
	{
  	"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.序列化:把我们识别的数据转换成指定的格式提供给别人
	eg:我们在django中获取到的数据默认是模型对象 但是模型对象数据无法直接提供给前端或别的平台使用 所以我们需要把数据进行序列化，变成字符串或者json数据 提供给别人

2.反序列化:把别人提供的数据转换/还原成我们需要的格式
	eg:前端js提供过来的json数据 对于python而言就是字符串 我们需要进行反序列化换成模型类对象 这样我们才能把数据保存到数据库中

djangorestframework快速使用

使用django这个web框架 开发前后端分离项目(模板渲染) 只能写接口
	使用JsonResponse返回即可--->>>:原生django

djangorestframework方便咱们快速的写出符合restful规范的接口
写接口:总共就5个及这5个的变形
	获取所有 get
	获取单个 get
	新增一条 post
	修改一条 put/patch
	删除一条 delete
    
由于drf是个模块需要先安装
	pip install djangorestframework

models.py里

from django.db import models

# Create your models here.

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

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

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写好后 路由配置如下
	path('test/', views.TestView.as_view()),
"""第一个参数是路径，第二个参数是试图函数的内存地址(视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址)
	去找as_view 找TestView类找 找不到 没有然后去父类在View"""
	@classonlymethod
	def as_view(cls,**initkwargs):
		def view(requset,*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方法
                # self.http_method_not_allowed 现在就是 get
                handler = getattr(self, self.http_method_not_allowed, self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
            return handler(request, *args, **kwargs)  # get(request)

标签：baidu,入门,接口,django,api,https,请求,com,drf
From： https://www.cnblogs.com/lisony/p/16724796.html

django之drf入门