四、【API 开发篇 (上)】：使用 Django REST Framework 构建项目与模块 CRUD API

前言

还记得我们的架构蓝图吗？

• 前端 (Vue3) 负责展示和交互。
  
• 后端 API (DRF) 是前后端沟通的桥梁。
  
• 后端逻辑 (Django) 处理业务和数据。
  
• 数据长期层 (Models/Database) 存储数据。
  

本日，我们的重点就是构建中间的“桥梁”——后端 API 层。
为什么选择 Django REST Framework (DRF)？

在 Django 生态系统中，DRF 是构建 RESTful API 的尺度。它提供了一系列强大的工具，可以极大地加速 API 的开发过程：

• Serializers (序列化器): 轻松地将复杂的 Django 模型对象转换成 JSON/XML 等格式（用于响应前端），或将吸收到的数据反序列化并验证（用于创建或更新数据）。
  
• Views / ViewSets (视图/视图集): 处理哀求和响应。ViewSets 特别方便，可以将多个相干的视图逻辑（如列表、详情、创建、更新、删除）合并到一个类中。
  
• Routers (路由): 自动生成 URL 模式，省去了手动编写大量 URLconf 的贫困。
  
• Authentication & Permissions (认证和权限): 提供了多种认证和权限机制，方便保护你的 API。
  
• Browsable API (可欣赏的 API): DRF 提供了一个非常友好的网页界面，可以直接在欣赏器中测试 API，对于开发和调试非常有效。
  

第一步：创建 Serializers (序列化器)

Serializers 负责数据的进出转换。我们需要为 Project 和 Module 模型创建对应的序列化器。
在 api 文件夹下，创建一个新文件 serializers.py。

打开 api/serializers.py，添加以下代码：

1. # test-platform/api/serializers.py
3. from rest_framework import serializers
4. from .models import Project, Module, TestCase # 导入你之前定义的模型
6. class ProjectSerializer(serializers.ModelSerializer):
7.     """
8.     项目序列化器
9.     """
10.     class Meta:
11.         model = Project # 指明要序列化的模型
12.         fields = '__all__' # 序列化模型中的所有字段
14. class ModuleSerializer(serializers.ModelSerializer):
15.     """
16.     模块序列化器
17.     """
18.     class Meta:
19.         model = Module # 指明要序列化的模型
20.         # 明确指定需要序列化的字段，包括外键 project
21.         # 注意：默认情况下，ModelSerializer 序列化外键时只会包含关联对象的 ID
22.         fields = ['id', 'name', 'description', 'project', 'create_time', 'update_time']
23.         # 也可以用 '__all__', 但明确指定有助于理解
24.         # fields = '__all__'

复制代码

代码解释：

• from rest_framework import serializers: 导入 DRF 的序列化器模块。
  
• from .models import ...: 导入我们在 models.py 中界说的模型。
  
• class ProjectSerializer(serializers.ModelSerializer):: 界说一个名为 ProjectSerializer 的类，它继续自 serializers.ModelSerializer。ModelSerializer 是 DRF 提供的一个便捷类，可以根据 Django 模型自动生成序列化器的字段。
  
• class Meta:: 在序列化器类内部界说一个 Meta 类，用于设置序列化器。
  
• model = Project: 指明这个序列化器是为哪个模型服务的。
  
• fields = '__all__': 表示序列化该模型的所有字段。你也可以使用一个列表来指定需要序列化的字段，比方 fields = ['id', 'name', 'owner']。对于 ModuleSerializer，我们明确列出了字段，包括了 project 外键字段。当序列化时，DRF 默认会显示外键关联对象的 ID。
  

第二步：创建 ViewSets (视图集)

ViewSets 负责处理 HTTP 哀求，调用序列化器举行数据转换，并与数据库交互。使用 ModelViewSet 可以非常快速地实现 CRUD 操作。
打开 api/views.py 文件，添加以下代码：

1. # test-platform/api/views.py
3. # from django.shortcuts import render # 这个现在用不到了
4. from rest_framework import viewsets
5. from .models import Project, Module, TestCase # 导入模型
6. from .serializers import ProjectSerializer, ModuleSerializer # 导入序列化器
8. class ProjectViewSet(viewsets.ModelViewSet):
9.     """
10.     项目管理视图集
11.     提供项目列表、创建、详情、更新、删除等接口
12.     """
13.     queryset = Project.objects.all() # 指定视图集查询的数据集
14.     serializer_class = ProjectSerializer # 指定用于序列化和反序列化的序列化器
16. class ModuleViewSet(viewsets.ModelViewSet):
17.     """
18.     模块管理视图集
19.     提供模块列表、创建、详情、更新、删除等接口
20.     """
21.     queryset = Module.objects.all() # 指定视图集查询的数据集
22.     serializer_class = ModuleSerializer # 指定用于序列化和反序列化的序列化器
24. # TestCaseViewSet 将在下一篇文章中实现，因为它涉及更复杂的序列化和逻辑
25. # class TestCaseViewSet(viewsets.ModelViewSet):
26. #     queryset = TestCase.objects.all()
27. #     serializer_class = TestCaseSerializer

复制代码

代码解释：

• from rest_framework import viewsets: 导入 DRF 的视图集模块。
  
• from .models import ... 和 from .serializers import ...: 导入相干的模型和序列化器。
  
• class ProjectViewSet(viewsets.ModelViewSet):: 界说一个 ProjectViewSet，继续自 viewsets.ModelViewSet。
  
• queryset = Project.objects.all(): 这是 ModelViewSet 所需的关键属性之一。它指定了该视图集将操作哪些数据聚集。这里是所有的 Project 对象。DRF 会根据这个 queryset 来执行列表、详情等操作。
  
• serializer_class = ProjectSerializer: 这是 ModelViewSet 所需的另一个关键属性。它指定了该视图集使用哪个序列化器来举行数据的输入验证和输出格式化。
  
• ModelViewSet 会自动为我们生成以下路由和对应的操作：
  
  
  
  • GET /projects/: 获取项目列表 (list action)
    
  • POST /projects/: 创建新项目 (create action)
    
  • GET /projects/{id}/: 获取指定 ID 的项目详情 (retrieve action)
    
  • PUT /projects/{id}/: 更新指定 ID 的项目 (update action)
    
  • PATCH /projects/{id}/: 部门更新指定 ID 的项目 (partial_update action)
    
  • DELETE /projects/{id}/: 删除指定 ID 的项目 (destroy action)
    
  
  

ModuleViewSet 的原理和 ProjectViewSet 完全一样，只是操作的对象酿成了 Module 模型和 ModuleSerializer。
第三步：设置 URLs (路由)

DRF 的 Routers 可以自动帮我们生成 ModelViewSet 对应的 URL 模式。
在 api 文件夹下，创建一个新文件 urls.py。

打开 api/urls.py，添加以下代码：

1. # test-platform/api/urls.py
3. from django.urls import path, include
4. from rest_framework.routers import DefaultRouter
5. from .views import ProjectViewSet, ModuleViewSet # 导入视图集
7. # 创建一个 DefaultRouter 实例
8. router = DefaultRouter()
10. # 注册视图集
11. # 第一个参数是 URL 前缀，例如 'projects'
12. # 第二个参数是视图集类
13. # 第三个参数是可选的 basename，用于生成 URL 名称，通常与 URL 前缀一致
14. router.register(r'projects', ProjectViewSet, basename='project')
15. router.register(r'modules', ModuleViewSet, basename='module')
17. # router.urls 会自动生成包含所有注册的 ViewSet 对应的 URL 模式列表
18. urlpatterns = [
19.     path('', include(router.urls)), # 将 router 生成的 URL 模式包含进来
20. ]

复制代码

代码解释：

• from rest_framework.routers import DefaultRouter: 导入 DRF 的默认路由类。
  
• from .views import ...: 导入我们刚刚创建的视图集。
  
• router = DefaultRouter(): 创建一个路由器实例。DefaultRouter 会自动包罗根视图（显示所有注册的 API 列表）和格式后缀模式。
  
• router.register(r'projects', ProjectViewSet, basename='project'): 注册 ProjectViewSet。访问路径会以 /projects/ 开头。比方 /projects/ (列表/创建), /projects/1/ (详情/更新/删除 ID 为 1 的项目)。
  
• router.register(r'modules', ModuleViewSet, basename='module'): 注册 ModuleViewSet，访问路径以 /modules/ 开头。
  
• urlpatterns = [...]: 界说 URL 模式列表。
  
• path('', include(router.urls)): 这一行将路由器自动生成的 URL 模式全部包罗进 api 应用的 URLconf 中。因为我们将这个 include 的第一个参数设为 ''，所以视图集注册时的 URL 前缀（如 projects, modules）会直接跟在应用 URL（比方 api/，我们稍后会在项目 urls.py 中设置）后面。
  

第四步：在项目 URLconf 中包罗 App 的 URLs

最后一步，我们需要在整个 Django 项目的 URL 设置文件 (backend/urls.py) 中，包罗我们 api App 的 URL 模式。
打开 test-platform/backend/urls.py 文件：

1. # test-platform/backend/urls.py
3. from django.contrib import admin
4. from django.urls import path, include # 确保导入了 include
6. urlpatterns = [
7.     path('admin/', admin.site.urls), # Django Admin 的 URL
8.     path('api/', include('api.urls')), # 添加这一行，将所有以 'api/' 开头的请求转发到 api.urls 处理
9. ]

复制代码

代码解释：

• from django.urls import path, include: 确保导入了 include 函数。
  
• path('api/', include('api.urls')): 这一行是关键。它告诉 Django，任何以 api/ 开头的 URL 哀求都应该“包罗”并交给 api 应用下的 urls.py 文件去处理。
  
• 联合 api/urls.py 中的 path('', include(router.urls))，终极的完备 URL 路径会是 /api/projects/, /api/modules/ 等。
  

第五步：测试 API

后端 API 已经基本搭建好了，现在来验证一下。

• 启动 Django 开发服务器：
  在终端中 (确保在 test-platform 目次下，并且 (venv) 已激活)，运行：
  
  1. python manage.py runserver

  复制代码
  
  
  
• 访问 DRF 的可欣赏 API 界面：
  在欣赏器中访问 http://127.0.0.1:8000/api/。
  
  
  
  如果看到以上页面内容，说明 DRF 和路由设置成功了。这个页面是 DefaultRouter 提供的根视图，列出了所有注册的 API 终端 (projects/ 和 modules/)。
  
• 测试 Project API：
  点击 http://127.0.0.1:8000/api/projects/ 链接。
  
  
  
  
  
  
  • GET (列表): 你会看到一个获取项目列表的页面。如果之前你在 Django Admin 中创建过项目，这里会显示出来。页面下方有一个表单，可以用来发送 POST 哀求创建新项目。
    
    
    
    
    
    
    
  • POST (创建): 在页面下方的表单中填写项目信息（名称, 形貌, 负责人, 项目状态），然后点击 POST 按钮。如果成功，会返回新创建的项目数据，并在上方列表中革新显示。
    
    
    
    
    
    
    
  • GET (详情): 在项目列表页面，点击某个项目的 URL (比方 http://127.0.0.1:8000/api/projects/1/)，可以检察该项目的详情。
    
    
    
    
  • PUT/PATCH/DELETE: 在项目详情页面，也会有 PUT (完全更新), PATCH (部门更新) 和 DELETE 的表单或按钮，你可以尝试修改或删除项目。
    
  
  
• 测试 Module API：
  返回 http://127.0.0.1:8000/api/，点击 http://127.0.0.1:8000/api/modules/ 链接。
  
  
  
  
  
  
  • GET (列表): 检察模块列表。
    
  • POST (创建): 创建模块时，请留意表单中会有 project 字段。你需要填写该模块所属项目的 ID。比方，如果你创建的第一个项目 ID 是 1，那么这里就填写 1。填写其他模块信息（name, description），然后 POST。
    
  • 测试详情、更新、删除操作与 Project 雷同。
    
    
    
    
  
  

通过可欣赏的 API 界面，你可以在不写任何前端代码的情况下，方便地验证你的后端 API 是否按照预期工作。
总结

你已经成功地迈出了后端 API 开发的关键一步：

• ✅ 理解了 DRF 在构建 API 中的作用和核心组件 (Serializers, ViewSets, Routers)。
  
• ✅ 为 Project 和 Module 模型创建了 ModelSerializer。
  
• ✅ 使用 ModelViewSet 快速实现了 Project 和 Module 的 CRUD 视图逻辑。
  
• ✅ 使用 DefaultRouter 自动生成了 API 的 URL 模式。
  
• ✅ 在项目 URL 设置中包罗了 API App 的 URL。
  
• ✅ 通过 DRF 的可欣赏 API 界面验证了你的 API 功能。
  

现在，你的后端已经可以或许响应前端对项目和模块数据的操作哀求了。
在下一篇文章中，我们将继续 API 开发，但会处理稍微复杂一些的 测试用例 (TestCase) 模型。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。