### Django REST Framework 完整操作流程示例 #### 一、创建项目和应用 为了构建RESTful API，首先需要安装Django以及Django REST framework。可以通过pip来完成这两个库的安装。 ```bash pip install django djangorestframework ``` 接着初始化一个新的Django项目，并创建一个应用程序用于实现具体的业务逻辑： ```bash django-admin startproject myapi cd myapi python manage.py startapp snippets ``` #### 二、配置settings.py文件 在项目的设置文件中添加`rest_framework`到已安装的应用列表里，并注册刚刚创建的应用程序`snippets`: ```python INSTALLED_APPS = [ ... 'rest_framework', 'snippets.apps.SnippetsConfig', # 注册新创建的应用 ] ``` #### 三、定义模型(Model) 编辑`models.py`以描述数据结构，在这里假设要存储代码片段(snippet)，可以这样写： ```python from django.db import models from pygments.lexers import get_all_lexers 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'] ``` #### 四、序列化器(Serializer) 编写`serializers.py`来转换复杂的数据库对象为JSON格式的数据流，反之亦然： ```python from rest_framework import serializers from .models import Snippet class SnippetSerializer(serializers.ModelSerializer): class Meta: model = Snippet fields = ('id', 'title', 'code', 'linenos', 'language', 'style') ``` #### 五、视图(Views) 利用前面提到过的类混合体(`DestroyModelMixin`, `ListModelMixin`)以及其他类似的组件快速搭建功能性的视图层。下面是一个基于通用视图集的例子： ```python from rest_framework import viewsets from .models import Snippet from .serializers import SnippetSerializer class SnippetViewSet(viewsets.ModelViewSet): """ This viewset automatically provides `list`, `create`, `retrieve`, `update` and `destroy` actions. """ queryset = Snippet.objects.all() serializer_class = SnippetSerializer ``` 上述代码通过继承自`viewsets.ModelViewSet`实现了对资源的基本CRUD操作[^1]。 #### 六、路由(Router) 最后一步就是把所有的端点映射到对应的视图上去了。DRF提供了一个非常方便的方式来做这件事——使用默认路由器(DefaultRouter)自动处理URL模式匹配工作： ```python from django.urls import path, include from rest_framework.routers import DefaultRouter from snippets import views as snippet_views router = DefaultRouter() router.register(r'snippets', snippet_views.SnippetViewSet) urlpatterns = [ path('', include(router.urls)), ] ``` 至此已经完成了整个API的设计与开发过程。启动服务器之后就可以访问http://localhost:8000/snippets/查看效果了。