在本教程中，我们将使用 Django Rest Framework （DRF）来构建一个简单的 API。我们将学习如何使用 DRF 提供可浏览的 API，并通过 RESTful 架构设计原则使我们的 API 易于扩展和维护。
首先，我们需要确保 Django Rest Framework 已经安装在我们的项目中。在此之前，请确保已经安装了 Django 并创建了一个新的 Django 项目。
一旦我们的 Django 项目创建完成，我们就可以安装 DRF。我们可以使用 pip 命令来安装它。在命令行中运行以下命令：
pip install djangorestframework接下来，我们需要在项目的 settings.py 文件中添加 DRF 的配置。找到 INSTALLED_APPS 配置项并在其中添加 'rest_framework'。它应该类似于以下代码：
INSTALLED_APPS = [
# ...
'rest_framework',
]
现在我们已经安装并配置好了 DRF，我们可以开始构建我们的 API。在我们的 Django 应用程序中，我们将创建一个新的 app，命名为 snippets。这个应用程序将提供一个简单的模型来存储代码片段，并将使用 DRF 来构建 API。
接下来，我们将定义模型。在 snippets 应用程序的 models.py 文件中添加以下代码：
from django.db import models
from pygments.lexers import get_all_lexers, get_lexer_by_name
from pygments.styles import get_all_styles
LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted([(item, item) for item in get_all_styles()])
class Snippet(models.Model):
created = models.DateTimeField(auto_now_add=True)
title = models.CharField(max_length=100, blank=True, default='')
code = models.TextField()
linenos = models.BooleanField(default=False)
language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)
class Meta:
ordering = ['created']
在这个模型中，我们定义了一个名为 Snippet 的模型类。它具有以下字段：
- created：一个自动生成的 DateTimeField，记录代码片段创建的时间。
- title：一个可选的 CharField，用于给代码片段命名。
- code：一个 TextField，用于存储代码片段本身。
- linenos：一个 BooleanField，用于记录是否要在代码片段中包括行号。
- language：一个 CharField，用于记录代码片段的编程语言。
- style：一个 CharField，用于记录代码片段的样式。
接下来，我们将定义 Snippet 的序列化器。在 snippets 应用程序的 serializers.py 文件中添加以下代码：
from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES
class SnippetSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True
created = serializers.DateTimeField()
title = serializers.CharField(required=False, allow_blank=True, max_length=100)
code = serializers.CharField(style={'base_template': 'textarea.html'})
linenos = serializers.BooleanField(required=False)
language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')
def create(self, validated_data):
"""
Create and return a new `Snippet` instance, given the validated data.
"""
return Snippet.objects.create(**validated_data)
def update(self, instance, validated_data):
"""
Update and return an existing `Snippet` instance, given the validated data.
"""
instance.title = validated_data.get('title', instance.title)
instance.code = validated_data.get('code', instance.code)
instance.linenos = validated_data.get('linenos', instance.linenos)
instance.language = validated_data.get('language', instance.language)
instance.style = validated_data.get('style', instance.style)
instance.save()
return instance
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
class SnippetList(APIView):
"""
List all snippets, or create a new snippet.
"""
def get(self, request, format=None):
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets, many=True)
return Response(serializer.data)
def post(self, request, format=None):
serializer = SnippetSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
class SnippetDetail(APIView):
"""
Retrieve, update or delete a snippet instance.
"""
def get_object(self, pk):
try:
return Snippet.objects.get(pk=pk)
except Snippet.DoesNotExist:
raise Http404
def get(self, request, pk, format=None):
snippet = self.get_object(pk)
serializer = SnippetSerializer(snippet)
return Response(serializer.data)
def put(self, request, pk, format=None):
snippet = self.get_object(pk)
serializer = SnippetSerializer(snippet, data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def delete(self, request, pk, format=None):
snippet = self.get_object(pk)
snippet.delete()
return Response(status=status.HTTP_204_NO_CONTENT)在这个视图中，我们使用 Django Rest Framework 的 views 模块来定义两个视图类：SnippetList 和 SnippetDetail。这两个视图类将分别处理列表视图和详细视图。在列表视图中，我们将获取所有的 Snippet 实例，并使用 SnippetSerializer 将它们转换为 JSON 格式。在详细视图中，我们将获取特定的 Snippet 实例，并使用 SnippetSerializer 将它转换为 JSON 格式。在创建视图中，我们将从请求数据中获取 Snippet 实例并使用 SnippetSerializer 进行验证和创建。
最后，我们将定义 snippets 应用程序的 URL。在 snippets 应用程序的 urls.py 文件中添加以下代码：
from django.urls import path
from snippets import views
urlpatterns = [
path('snippets/', views.SnippetList.as_view()),
path('snippets//', views.SnippetDetail.as_view()),
]
在这个 URL 配置中，我们定义了两个 URL 路径，分别对应于 SnippetList 和 SnippetDetail 视图类。
现在，我们已经完成了 snippets 应用程序的所有组件，并且可以在浏览器中测试它。运行以下命令启动开发服务器：
python manage.py runserver在浏览器中打开
http://localhost:8000/snippets/，您将看到 SnippetList 视图返回的所有 Snippet 实例的 JSON 格式。您还可以使用 POST 请求将新的 Snippet 实例添加到列表中。
在浏览器中打开
http://localhost:8000/snippets/1/，您将看到 SnippetDetail 视图返回的特定 Snippet 实例的 JSON 格式。您还可以使用 PUT 请求更新这个实例，或使用 DELETE 请求删除这个实例。
以上就是 Django Rest Framework 官方教程的全部内容。通过这个教程，您可以学习如何使用 Django Rest Framework 来构建 RESTful API。
除了本教程所涉及的内容之外，Django Rest Framework 还提供了许多其他功能和选项，例如认证、权限、分页、过滤、搜索等。您可以在官方文档中查找更多信息。
此外，Django Rest Framework 还可以与其他 Django 应用程序和插件配合使用。例如，您可以使用 django-filter 库提供更高级的过滤功能，使用 django-guardian 库提供更复杂的权限管理，使用 django-rest-swagger 库提供交互式文档。
总之，Django Rest Framework 是一个非常强大和灵活的框架，可以帮助您快速构建高质量的 RESTful API。无论您是正在开发自己的 Web 应用程序，还是正在为客户构建 API，Django Rest Framework 都是值得考虑的一个选择。