DRF基础:工程搭建
环境安装与配置#
DRF 需要以下依赖:
- Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
- Django (1.10, 1.11, 2.0)
DRF 是以 Django 扩展应用的方式提供的,所以我们可以直接利用已有的 Django 环境而无需从新创建。(若没有 Django 环境,需要先创建环境安装 Django)
安装 DRF#
pip install djangorestframework
添加 rest_framework 应用#
我们利用在 Django 框架学习中创建的 demo 工程,在 settings.py 的 INSTALLED_APPS 中添加’rest_framework’。
INSTALLED_APPS = [
...
'rest_framework',
]
接下来就可以使用 DRF 进行开发了。
见识 DRF 的魅力#
我们仍以在学习 Django 框架时使用的图书英雄为案例,使用 Django REST framework 快速实现图书的 REST API。
创建序列化器#
在 booktest 应用中新建 serializers.py 用于保存该应用的序列化器。
创建一个 BookInfoSerializer 用于序列化与反序列化。
class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = '__all__'
- model 指明该序列化器处理的数据字段从模型类 BookInfo 参考生成
- fields 指明该序列化器包含模型类中的哪些字段,’all‘指明包含所有字段
编写视图#
在 booktest 应用的 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
- queryset 指明该视图集在查询数据时使用的查询集
- serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
定义路由#
在 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的路由列表中
运行测试#
运行当前程序(与运行 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 按钮,可以访问删除图书的接口:
返回,如下页面:
至此,是不是发现 Django REST framework 很好用!
推荐文章: