随着互联网的不断发展，Web API 越来越成为了应用程序开发的重要组成部分。RESTful API 是一个基于 HTTP 协议实现的面向资源的 API 设计风格，被广泛应用于 Web 应用程序的开发中。本文将介绍如何使用 Django REST framework 构建 RESTful API，并为读者提供深入学习和指导意义。
什么是 Django REST framework
Django REST framework 是一个基于 Django 框架的 Web API 开发框架，它使创建、测试和维护 RESTful Web API 变得更加容易。Django REST framework 提供了一系列的工具和库，使开发者能够更加高效地进行 RESTful API 的设计与实现。
Django REST framework 的主要特点如下：
- 支持多种认证方式，如基于令牌的身份验证、Oauth 认证、Session 认证等；
- 支持多种格式的数据序列化和反序列化，如 XML、JSON、HTML、CSV 等；
- 提供了一套清晰的路由系统，使开发者能够轻松定义 API 路由和 URL 映射；
- 支持缓存，使请求得到快速响应；
- 提供了丰富的文档和示例代码，使开发者更快掌握 Django REST framework 的使用。
如何构建 RESTful API
接下来，我们将使用 Django REST framework 构建一个简单的 RESTful API，包括用户注册、登录、注销、添加文章、查询文章等操作。
安装 Django REST framework
要使用 Django REST framework，首先需要安装它。我们可以使用 pip 命令进行安装：
pip install djangorestframework
除此之外，还需要在 settings.py 文件中添加 REST framework 的相关配置：
// javascriptcn.com 代码示例
INSTALLED_APPS = [
# ...
'rest_framework',
]
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
],
}上述配置包括了 REST framework 的认证和权限设置，其中默认使用 Token 认证和 Session 认证，需要用户登录后才能访问 API。
创建 Django 应用程序和 Models
在 Django 中创建一个应用程序非常简单，我们可以使用如下命令创建一个名为 article 的应用程序：
django-admin startapp article
在 article 应用程序中我们定义两个 Models：User 和 Article：
// javascriptcn.com 代码示例
# article/models.py
from django.db import models
class User(models.Model):
username = models.CharField(max_length=100, unique=True)
password = models.CharField(max_length=100)
class Article(models.Model):
title = models.CharField(max_length=100)
content = models.TextField()
author = models.ForeignKey(User, on_delete=models.CASCADE)
created_at = models.DateTimeField(auto_now_add=True)上述 Models 定义了两个表格：User 表格保存用户信息，包括用户名和密码；Article 表格保存文章信息，包括标题、内容、作者和创建时间。
创建 Serializer 和 View
在 Django REST framework 中，Serializer 是用于对 Model 进行序列化和反序列化的工具，View 则负责处理 HTTP 请求。我们需要创建如下 Serializer 和 View：
// javascriptcn.com 代码示例
# article/serializers.py
from rest_framework import serializers
from .models import User, Article
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = ['id', 'username', 'password']
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ['id', 'title', 'content', 'author', 'created_at']
// javascriptcn.com 代码示例
# article/views.py
from rest_framework import generics, status, authentication, permissions
from rest_framework.response import Response
from rest_framework.authtoken.models import Token
from .models import User, Article
from .serializers import UserSerializer, ArticleSerializer
class UserCreateView(generics.CreateAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
class UserLoginView(generics.GenericAPIView):
serializer_class = UserSerializer
def post(self, request, *args, **kwargs):
username = request.data.get('username')
password = request.data.get('password')
try:
user = User.objects.get(username=username, password=password)
except User.DoesNotExist:
return Response({'error': 'Invalid username or password'}, status=status.HTTP_401_UNAUTHORIZED)
token, created = Token.objects.get_or_create(user=user)
return Response({'token': token.key}, status=status.HTTP_200_OK)
class UserLogoutView(generics.GenericAPIView):
authentication_classes = [authentication.TokenAuthentication]
permission_classes = [permissions.IsAuthenticated]
def post(self, request, *args, **kwargs):
request.user.auth_token.delete()
return Response(status=status.HTTP_200_OK)
class ArticleListView(generics.ListAPIView):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
class ArticleCreateView(generics.CreateAPIView):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
authentication_classes = [authentication.TokenAuthentication]
permission_classes = [permissions.IsAuthenticated]
def perform_create(self, serializer):
serializer.save(author=self.request.user)上述代码中，UserCreateView 负责用户注册，UserLoginView 负责用户登录，UserLogoutView 负责用户注销，ArticleListView 负责查询文章，ArticleCreateView 负责添加文章。其中，UserLoginView、UserLogoutView 和 ArticleCreateView 需要认证和授权才能访问。
配置路由
在 Django REST framework 中，路由系统使用 Django 的 URLconf 实现。我们需要在 urls.py 中定义如下路由：
// javascriptcn.com 代码示例
# article/urls.py
from django.urls import path
from rest_framework.authtoken.views import obtain_auth_token
from .views import UserCreateView, UserLoginView, UserLogoutView, ArticleListView, ArticleCreateView
urlpatterns = [
path('register/', UserCreateView.as_view(), name='user-create'),
path('login/', UserLoginView.as_view(), name='user-login'),
path('logout/', UserLogoutView.as_view(), name='user-logout'),
path('articles/', ArticleListView.as_view(), name='article-list'),
path('articles/create/', ArticleCreateView.as_view(), name='article-create'),
path('api-token-auth/', obtain_auth_token, name='api-token-auth'),
]上述路由中，/register/ 对应 UserCreateView，/login/ 对应 UserLoginView，/logout/ 对应 UserLogoutView，/articles/ 对应 ArticleListView，/articles/create/ 对应 ArticleCreateView。
测试 RESTful API
接下来，我们使用 Postman 工具测试我们构建的 RESTful API。
首先，我们使用 POST 方法对 /register/ 进行测试，向服务器提交一个 JSON 格式的用户信息：
{
"username": "user1",
"password": "123456"
}如果注册成功，服务器将返回一个 JSON 格式的响应：
{
"id": 1,
"username": "user1",
"password": "123456"
}接下来，我们使用 POST 方法对 /login/ 进行测试，向服务器提交一个 JSON 格式的用户信息进行登录：
{
"username": "user1",
"password": "123456"
}如果登录成功，服务器将返回一个 JSON 格式的响应，其中包含一个 token：
{
"token": "78d8b7377d230c6ab3747676f07fadeae8ca7497"
}接下来，我们使用 GET 方法对 /articles/ 进行测试，服务器将返回文章列表。接着，我们使用 POST 方法对 /articles/create/ 进行测试，向服务器提交一个 JSON 格式的文章信息：
{
"title": "Test Article",
"content": "This is a test article."
}如果添加文章成功，服务器将返回一个 JSON 格式的响应：
{
"id": 1,
"title": "Test Article",
"content": "This is a test article.",
"author": 1,
"created_at": "2022-01-01T00:00:00Z"
}最后，我们使用 POST 方法对 /logout/ 进行测试，服务器将清除当前用户的身份验证 Token。
总结
Django REST framework 是一个充满活力的 Web API 开发框架，其功能强大，易于使用。本文介绍了如何使用 Django REST framework 构建 RESTful API 的详细步骤，并提供了示例代码和测试方法，希望能够为读者提供深入学习和指导意义。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6522779895b1f8cacd9f3795