2022年Django Rest框架介绍（django框架百度百科）

在本系列中，我们将介绍使用 Django Rest Framework 构建 API 的基础知识。 在第一个教程中，我们将介绍一些基本设置和概念，我们将在本系列的未来补充中使用它们。 第一个教程将遵循文档中的快速入门。 稍后我们将花一些时间更详细地了解这些概念，但现在我们只需要开始做一些事情。

项目设置

在我们做任何其他事情之前，我们需要设置我们的项目。 首先让我们为项目创建一个目录，安装所有东西并创建一个 django 项目。

mkdir music_api_tutorial
cd music_api_tutorial# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate  # On Windows use `env\Scripts\activate`# Install Django and Django REST framework into the virtual environment
pip install django
pip install djangorestframework# Set up a new project with a single application
django-admin startproject music_api .
cd music_api
django-admin startapp catalog
cd ..

现在我们有了一个项目，我们需要确保在 settings.py 文件中将 rest 框架添加到您的 installed_apps 中。

INSTALLED_APPS = [
'rest_framework',
]

序列化器

在第一个教程中，我们将按照文档设置基本的序列化程序、视图和 url。 我们将更详细地介绍这些单独的部分在未来是如何工作的，但现在我们只关注一个基本示例。 首先我们需要设置一个序列化器。 序列化程序将处理 Django 模型对象与本机 Python 数据类型之间的转换，我们可以轻松地将其呈现为 JSON 以作为 API 的响应发送。 幸运的是，Django 有很多内置的类让我们更容易做到这一点。 现在让我们使用其中之一。

from django.contrib.auth.models import User, Group
from rest_framework import serializersclass UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'groups']class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ['url', 'name']

我们设置了一个用户序列化器和一个组序列化器。 这些都来自内置模型，因此我们不必担心定义用户或组是什么，当我们安装 Django 时，它会附带。

意见

现在我们需要实际创建用于与 API 交互的端点。 让我们像文档一样设置用户和组视图集。 现在我们只需要知道视图集将为我们处理所有的创建、读取、更新和删除操作。

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
from tutorial.quickstart.serializers import UserSerializer, GroupSerializerclass UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]class GroupViewSet(viewsets.ModelViewSet):
    queryset = Group.objects.all()
    serializer_class = GroupSerializer
    permission_classes = [permissions.IsAuthenticated]

这处理了我们视图所需的一切。 现在我们需要一种访问视图的方法。 这就是我们的网址发挥作用的地方。

网址

让我们设置一个 url 模式来访问这两个视图。 要设置它，我们可以使用 path() 函数并设置模式、视图，还可以选择设置名称。 模式将是用户访问的实际 url，视图将是在此 url 模式中使用的函数视图、类视图或视图集。 如果是类视图或视图集，则需要在视图名称后添加 .as_view() 。 可选名称可以使在 api 的其他部分中引用 url 更容易。

from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import viewsrouter = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

由于我们使用的是视图集，因此我们也可以使用路由器。 路由器将自动处理视图集需要的不同 url 模式。 例如，用户视图集需要两个 url。 /users/ 将具有获取和发布所有用户和创建新用户的方法。 /users// 将具有 get、post、put、delete 以通过其 id 更新或获取特定用户。 将被替换为 id。 在这种情况下，我们使用的是 DefaultRouter，还有其他可用选项，但对于基本示例，这将正常工作。 我们还需要将路由器包含在它自己的 path() 中，这样它才能正常工作，我们也这样做了。

分页

最后让我们设置一些基本的分页设置。

REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}

测试 API

现在我们应该把所有东西都设置好。 我们可以通过以下方式对其进行测试。

python3 manage.py runserver

现在你有两个选项来测试，要么打开像 postman 或 insomnia 这样的 api 客户端，然后以这种方式测试 url 路由，要么因为我们在我们的 url 中设置了它

我们将在本教程中停下来。 稍后我们将返回并更详细地浏览这些部分，以更好地了解所有这些是如何工作的。