Django REST framework(DRF)是一个强大的Web框架,用于构建API。它基于Django框架,提供了许多高级功能,如序列化、认证、权限、视图集等。通过学习Django REST framework,你可以轻松构建RESTful API接口,提高开发效率。本文将带你通过实战项目,一步步学会Django REST framework。
一、项目准备
在开始之前,请确保你的计算机上已安装以下软件:
- Python 3.x
- Django 3.x
- Django REST framework
你可以通过以下命令安装:
pip install django
pip install djangorestframework
二、创建Django项目
- 创建一个名为
myproject的新目录,并进入该目录。
mkdir myproject
cd myproject
- 创建一个名为
myapp的新应用。
django-admin startapp myapp
- 在
myproject/settings.py文件中,添加以下代码:
INSTALLED_APPS = [
...
'rest_framework',
'myapp',
]
- 创建数据库表。
python manage.py makemigrations myapp
python manage.py migrate
三、创建模型
在myapp/models.py文件中,定义一个简单的模型Book:
from django.db import models
class Book(models.Model):
title = models.CharField(max_length=100)
author = models.CharField(max_length=100)
publish_date = models.DateField()
def __str__(self):
return self.title
四、序列化模型
在myapp/serializers.py文件中,创建一个名为BookSerializer的序列化器:
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = '__all__'
五、创建视图
在myapp/views.py文件中,创建一个名为BookViewSet的视图集:
from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer
class BookViewSet(viewsets.ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
六、配置路由
在myproject/urls.py文件中,添加以下代码:
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include('myapp.urls')),
]
在myapp/urls.py文件中,添加以下代码:
from django.urls import path
from .views import BookViewSet
urlpatterns = [
path('books/', BookViewSet.as_view()),
]
七、运行项目
- 启动Django开发服务器:
python manage.py runserver
- 打开浏览器,访问
http://127.0.0.1:8000/api/books/,查看Book列表。
八、总结
通过以上步骤,你已经成功使用Django REST framework创建了一个简单的API接口。在实际项目中,你可以根据需求添加更多功能,如分页、过滤、排序等。希望本文能帮助你快速掌握Django REST framework,为你的开发工作带来便利。
