aweilark 2019-12-10
Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。帮助我们简化开发REST API的工作。DRF框架是建立在Django框架基础之上,由Tom Christie大牛二次开发的开源项目。
官方文档:http://www.django-rest-framework.org/
Github源码:https://github.com/encode/django-rest-framework/tree/master
DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需从新创建。(若没有Django环境,需要先创建环境安装Django)
1. 安装DRF
pip install djangorestframework
2. 添加rest_framework应用
利用在Django框架创建的工程,在settings.py的INSTALLED_APPS中添加‘rest_framework‘。
INSTALLED_APPS = [ ... ‘rest_framework‘, ]
3. 创建序列化器
Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。
例如,我们已有了一个数据库模型类BookInfo
class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name=‘名称‘) bpub_date = models.DateField(verbose_name=‘发布日期‘, null=True) bread = models.IntegerField(default=0, verbose_name=‘阅读量‘) bcomment = models.IntegerField(default=0, verbose_name=‘评论量‘) image = models.ImageField(upload_to=‘booktest‘, verbose_name=‘图片‘, null=True)
(1)定义Serializer
在index应用中新建serializers.py用于保存该应用的序列化器。
创建一个BookInfoSerializer用于序列化与反序列化。
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label=‘ID‘, read_only=True) btitle = serializers.CharField(label=‘名称‘, max_length=20) bpub_date = serializers.DateField(label=‘发布日期‘, required=False) bread = serializers.IntegerField(label=‘阅读量‘, required=False) bcomment = serializers.IntegerField(label=‘评论量‘, required=False) image = serializers.ImageField(label=‘图片‘, required=False) class Meta: model = BookInfo fields = ‘__all__‘
注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
(2)字段与选项
常用字段类型:
字段 | 字段构造方式 |
---|---|
BooleanField | BooleanField() |
NullBooleanField | NullBooleanField() |
CharField | CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) |
EmailField | EmailField(max_length=None, min_length=None, allow_blank=False) |
RegexField | RegexField(regex, max_length=None, min_length=None, allow_blank=False) |
SlugField | SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+ |
URLField | URLField(max_length=200, min_length=None, 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, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ListField | ListField(child=<a_field_instance>, min_length=None, max_length=None) |
DictField | DictField(child=<a_field_instance>) |
选项参数:
参数名称 | 作用 |
---|---|
max_length | 最大长度 |
min_lenght | 最小长度 |
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页面时,显示的字段帮助提示信息 |
4. 编写视图
在index应用的views.py中创建视图BookInfoViewSet,这是一个视图集合。
from rest_framework.viewsets import ModelViewSet from .serializers import BookInfoSerializer from .models import BookInfo class BookInfoViewSet(ModelViewSet): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer
5. 定义路由
在booktest应用的urls.py中定义路由信息。
from . import views from rest_framework.routers import DefaultRouter urlpatterns = [ ... ] router = DefaultRouter() # 可以处理视图的路由器 router.register(r‘books‘, views.BookInfoViewSet) # 向路由器中注册视图集 urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
6. 运行测试
运行当前程序(与运行Django一样)
python manage.py runserver
在浏览器中输入网址127.0.0.1:8000,可以看到DRF提供的API Web浏览页面:
1)点击链接127.0.0.1:8000/books/ 可以访问获取所有数据的接口,呈现如下页面:
2)在页面底下表单部分填写图书信息,可以访问添加新图书的接口,保存新书:
点击POST后,返回如下页面信息:
3)在浏览器中输入网址127.0.0.1:8000/books/1/,可以访问获取单一图书信息的接口(id为1的图书),呈现如下页面:
4)在页面底部表单中填写图书信息,可以访问修改图书的接口:
点击PUT,返回如下页面信息:
5)点击DELETE按钮,可以访问删除图书的接口:
返回,如下页面: