Django REST framework框架是一个用于构建Web API的强大而又灵活的工具. 通常简称为DRF框架 或 REST framework框架.
特点
- 提供了定义序列化器serializer的方法,可以快速根据Django ORM或者其他库自动序列化/反序列化;
- 提供了丰富的类视图、Mixin扩展类、简化视图的编写;
- 丰富的定制层级: 函数视图、类视图、视图集合到自动生成API,满足各种需求;
- 多中身份认证和权限认证方式的支持;
- 内置了限流系统;
- 直观的API web界面;
- 可扩展性, 插件丰富
那什么叫序列化和反序列化呢?
序列化 反序列化
序列化 指的是 把模型数据转化成可传输的数据 (像json这种就是可传输的数据)
反序列化指的是 把可传输的数据转化成模型类的数据
官方文档
https://www.django-rest-framework.org/
源码地址
https://github.com/encode/django-rest-framework/tree/master
环境安装
pip install -i https://pypi.douban.com/simple djangorestframework==3.8.2
安装完成之后一定要注册
INSTALLED_APPS = [
‘’’’’’
‘rest_framework’
]
简单的使用
模型类
创建一个学生和小组的模型类
之间的关系:一对多
from django.db import models
# Create your models here.
class Group(models.Model):
name = models.CharField(verbose_name='小组名字',max_length=10)
class Student(models.Model):
name = models.CharField(verbose_name='学生名字',max_length=10)
age = models.IntegerField(verbose_name='学生年龄')
group = models.ForeignKey(to=Group,on_delete=models.CASCADE)
写完了之后,要注意迁移文件
迁移文件的命令
python manage.py makemigrations
python manage.py migrate
然后利用pycharm自带的sqlite数据库,填一些假数据
添加完假数据之后,按那个DB键(红线上方)就可以
使用这个自带的sqlite数据库,可能要安装一下驱动。
再添加学生的假数据
有了数据之后,就要去写一个序列化文件
序列化
先在应用下新建一个serializers.py文件,目的是序列化我们的模型类。
结构是这样的,每一个模型类都会对应一个序列化
在新建的这个文件中写入下面的代码
from rest_framework.serializers import HyperlinkedModelSerializer
from .models import Group,Student
#导入模型类
#先序列化小组类
class GroupSerializer(HyperlinkedModelSerializer):
class Meta:
#告诉它(新建的这个类),你要序列化哪个模型类以及要序列化这个类里面的哪些字段
model = Group
fields = ('id','name')
class StudentSerializer(HyperlinkedModelSerializer):
class Meta:
model = Student
fields = ('id','name','age','group')
这个序列化就完了
下面就开始写视图
写视图
from django.shortcuts import render
from rest_framework import viewsets
from .models import *
#导入模型类
from .serializers import *
#导入序列化类
# Create your views here.
class StudentViewSet(viewsets.ModelViewSet):
queryset = Student.objects.all()
#把查出的所有学生数据都序列化
serializer_class = StudentSerializer
#告诉它改完数据之后,用了哪个序列化类
class GroupViewSet(viewsets.ModelViewSet):
queryset = Group.objects.all()
serializer_class = GroupSerializer
配置路由
根及路由下
from django.contrib import admin
from django.urls import path,include
from app01 import views
from rest_framework.routers import DefaultRouter
#使用提供的路由
route = DefaultRouter()
#把视图生成的路由注册到这个里
route.register(r'students',views.StudentViewSet)
route.register(r'groups',views.GroupViewSet)
#这样的话,他会帮我们生成对应的路由
'''
http://127.0.0.1:8000/students就会生成这样的路由
如果是获取当个学生的话,路由就是
http://127.0.0.1:8000/students/1/
'''
urlpatterns = [
path('admin/', admin.site.urls),
path('api/',include(route.urls)),
#这个加上api之后的路由就是http://127.0.0.1:8000/api/students
]
启动服务器
python manage.py runserver
访问浏览器http://127.0.0.1:8000/api/
会展示出这样的数据
这些路由默认路由自动生成的,点进去之后
可以看到所有的学生,并且还可以增加学生
但是,增加学生的地方
也就是这个地方,它显示的并不是小组的名字,那么如何让他显示小组的名字呢
在模型类中,用str方法就好了
然后,再刷新页面看
这样就好了,并且也可以访问当个学生