day71:drf:API接口&Restful API规范&Django Rest Fr

https://www.jd.com
https://api.example.com

https://example.org/api/+

http://www.example.com/app/1.0/foo
?
http://www.example.com/app/1.1/foo
?
http://www.example.com/app/2.0/foo

Accept: vnd.example-com.foo+json; version=1.0
?
Accept: vnd.example-com.foo+json; version=1.1
?
Accept: vnd.example-com.foo+json; version=2.0

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH（或）PUT /products/4 ：将更新产品 4

获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products

GET /zoos：# 列出所有动物园
POST /zoos： 新建一个动物园（上传文件）
GET /zoos/ID： 获取某个指定动物园的信息
PUT /zoos/ID： 更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID： 更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID： 删除某个动物园
GET /zoos/ID/animals： 列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID： 删除某个指定动物园的指定动物

?limit=10： 指定返回记录的数量
?offset=10： 指定返回记录的开始位置。
?page=2&per_page=100： 指定第几页，以及每页的记录数。
?sortby=name&order=asc： 指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1： 指定筛选条件

/zoos/2/animals

/animals?zoo_id=2

{
    error: "Invalid API key"
}

{
current_user_url": https://api.github.com/user,authorizations_urlhttps://api.github.com/authorizations ...
}

{
  messageRequires authenticationdocumentation_urlhttps://developer.github.com/v3
}

pip3 install django==2.2  安装django2 不要安装django1
pip3 install djangorestframework  安装drf

django-admin startproject drfdemo

INSTALLED_APPS = [
    ...
    'rest_framework'接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：



将请求的数据（如JSON格式）转换为模型类对象


操作数据库


将模型类对象转换为响应的数据（如JSON格式）



4.drf的强大之处
下面将会告诉你用drf写代码的完整步骤:
0.创建模型操作类:students/models.py
创建一个app，名字为students

class Student(models.Model):
     模型字段
    name = models.CharField(max_length=100,verbose_name=姓名",help_text=提示文本：不能为空)
    sex = models.BooleanField(default=1,1)">性别)
    age = models.IntegerField(verbose_name=年龄)
    class_null = models.CharField(max_length=5,1)">班级编号)
    description = models.TextField(max_length=1000,1)">个性签名)

     Meta:
        db_table=tb_student"  将表名改为tb_student
        verbose_name = 学生
        verbose_name_plural = verbose_name

1.执行准备工作
1.将student组件添加到settings.py中的INSTALLAPP中
2.安装pymysql,执行数据库连接

pip install pymysql

3.在项目目录下的__init__.py中使用pymysql作为数据库驱动

import pymysql
pymysql.install_as_MySQLdb()

4.settings.py中设置数据库的相关配置

DATABASES = {
    default: {
        ENGINE': django.db.backends.mysqlNAMEstudentsHOST127.0.0.1PORT": 3306USERrootPASSWORD":123
python manage.py makemigrations
python manage.py migrate

6.在执行?python manage.py makemigrations会报出如下错误

解决方法:
注释掉 python/site-packages/django/backends/mysql/base.py中的35和36行代码。

7.在执行?python manage.py migrate会报如下错误

解决方法:
backends/mysql/operations.py146行里面新增一个行代码：

2.创建序列化器 students/serializers.py
在students应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。

 创建序列化器类，回头会在试图中被调用
 StudentModelSerializer(serializers.ModelSerializer):
     Meta:
        model = Student
        fields = __all__"



model 指明该序列化器处理的数据字段从模型类Student参考生成


fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段


3.编写视图集合函数 students/views.py
在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。

from rest_framework.viewsets  ModelViewSet
from .models  Student
from .serializers  StudentModelSerializer

 StudentViewSet(ModelViewSet):
    queryset = Student.objects.all() 
    serializer_class = StudentModelSerializer

4.定义路由 students/urls.py
在students应用的urls.py中定义路由信息。

from .  views
from rest_framework.routers  DefaultRouter

 路由列表
urlpatterns = []

router = DefaultRouter()   可以处理视图的路由器，自动通过视图来生成增删改查的url路径

router.register(',views.StudentViewSet)  students是生成的url前缀，名称随便写， 向路由器中注册视图集

urlpatterns += router.urls   将路由器中的所以路由信息追到到django的路由列表中

最后把students子应用中的路由文件加载到总路由文件中.

 drf01/urls.py
from django.contrib  admin
from django.urls  path,include

urlpatterns = [
    path(admin/stu/students.urls)),]

5.运行测试
点击链接127.0.0.1:8000/stu/students 可以访问获取所有数据的接口
我们可以通过这个页面来进行对数据的增删改查

?

5.序列化器的使用

1.序列化功能
1.先创建一个app：sers

python manage.py startapp sers

2.我们已有了一个数据库模型类students/Student，使用这个数据模型类即可。
3.如果我们想为这个模型类提供一个序列化器，可以定义如下：
a.在应用中创建一个py文件,比如叫做serializers.py

from rest_framework  serializers
 StudentSerizlizer(serializers.Serializer):

    name = serializers.CharField()
    age = serializers.IntegerField()
    class_null = serializers.CharField()
    description = serializers.CharField()

b.在视图sers/views.py中使用序列化功能

from django.shortcuts  render,HttpResponse
from django.http  JsonResponse
from students  models
from django.views  View
 StudentSerizlizer

 StudentView(View):

    def get(self,request):
        
         查询所有数据
        all = models.Student.objects.all() 
        
         查询一条数据
        one = models.Student.objects.get(id=1)  
        
         多条记录序列化必须加many=True参数
        '''serializer.data是列表里有多个小字典的形式'''
        serializer = StudentSerizlizer(all,many=True)
        
         单条记录序列化
        serializer.data是一个字典
        serializer = StudentSerizlizer(one)  得到的结果为字典 data


         若要序列化非dict对象，需要添加safe=false参数
          若要显示中文，需要添加ensure_ascii选项
        return JsonResponse(serializer.data,safe=False,json_dumps_params={ensure_ascii':False})

注意：serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
c.配置一下应用列表和数据库

INSTALLED_APPS =students.apps.StudentsConfigser
]
DATABASES =drf01':':3306123456
    }
}


2.反序列化功能
和序列化功能相同，在django中创建一个反序列化功能的app
然后在app下的创建一个文件serializer.py

 serializers

 自定义校验函数
 check666(val):
    if 666' in val:
        raise serializers.ValidationError(不能光喊6666啊，没有用)
    else:
        return val

 StudentSerizlizer(serializers.Serializer):

     validatior代表检查name时，会通过一遍check666函数
    name = serializers.CharField(max_length=4,validators=[check666,])
    age = serializers.IntegerField(max_value=18)
    class_null = serializers.CharField()
    
     required=False,allow_null=True允许字段为空，也就是不用传递过来这个data
    description = serializers.CharField(required=False,allow_null=True)
    
     allow_blank=True 允许只为空字符串 
    description = serializers.CharField(allow_blank=True)

在视图中使用反序列化功能
在反序列化中，主要的就是校验功能

 Student(View):
     post(self,request):
        
             content-type :客户端实际返回的内容的内容类型
            if content-type == 'urlencoded':
                 #username=chao&password=123&a=1
                 request.POST['username'] = 'chao'
              elif content-type == 'form-data':
                 # 分片接受数据
                 request.FILES
             
        django没有自带解析json数据的解析器，所以需要我们手动的解析，但是drf中已经有了
        content - type == 'application/json'
        '''
        print(request.POST)
        recv_data = {
            name':request.POST.get(),1)">ageclass_nulldescriptionrecv_data)
        print(ser.is_valid())  校验，全部通过得到True，一个字段错了都是得到False
        print(ser.errors)  所有字段的错误信息

        return HttpResponse(ok')

3.在序列化功能和反序列化功能的serializer.py中我们会经常用到一些字段和参数
常用字段:


字段
字段构造方式



BooleanField
BooleanField()


NullBooleanField
NullBooleanField()


CharField
CharField(max_length=None,min_length=None,allow_blank=False,trim_whitespace=True)


EmailField
EmailField(max_length=None,allow_blank=False)


RegexField
RegexField(regex,max_length=None,allow_blank=False)


SlugField
SlugField(maxlength=50,allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+


URLField
URLField(max_length=200,allow_blank=False)


UUIDField
UUIDField(format='hex_verbose') format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2） 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3）'int' - 如: "123456789012312313134124512351145145114" 4）'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 微软时间戳，通过微秒生成一个随机字符串


IPAddressField
IPAddressField(protocol='both',unpack_ipv4=False,**options)


IntegerField
IntegerField(max_value=None,min_value=None)


FloatField
FloatField(max_value=None,min_value=None)


DecimalField
DecimalField(max_digits,decimal_places,coerce_to_string=None,max_value=None,min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置


DateTimeField
DateTimeField(format=api_settings.DATETIME_FORMAT,input_formats=None)


DateField
DateField(format=api_settings.DATE_FORMAT,input_formats=None)


TimeField
TimeField(format=api_settings.TIME_FORMAT,input_formats=None)


DurationField
DurationField()


ChoiceField
ChoiceField(choices) choices与Django的用法相同


MultipleChoiceField
MultipleChoiceField(choices)


FileField
FileField(max_length=None,allow_empty_file=False,use_url=UPLOADED_FILES_USE_URL)


ImageField
ImageField(max_length=None,use_url=UPLOADED_FILES_USE_URL)


ListField
ListField(child=,max_length=None)


DictField
DictField(child=)



?
选项参数


参数名称
作用



max_length
最大长度


min_length
最小长度


allow_blank
是否允许为空


trim_whitespace
是否截断空白字符


max_value
最大值


min_value
最小值



?
?
?
?
?
?
?
?
?
通用参数


参数名称
说明



read_only
表明该字段仅用于序列化输出，默认False


write_only
表明该字段仅用于反序列化输入，默认False


required
表明该字段在反序列化时必须输入，默认True


default
反序列化时使用的默认值


allow_null
表明该字段是否允许传入None，默认False


validators
该字段使用的验证器


error_messages
包含错误编号与错误信息的字典


label
用于HTML展示API页面时，显示的字段名称


help_text
用于HTML展示API页面时，显示的字段帮助提示信息


                        
（编辑：李大同）
【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!