### 封装 API 接口的方法 在 Python Django 中封装 API 接口通常涉及以下几个方面： #### 1. 创建 Django 应用 通过命令 `python manage.py startapp myfirstapp` 可以创建一个新的应用[^1]。此操作会生成一个名为 `myfirstapp` 的目录结构，其中包含了模型、视图和其他配置文件。 #### 2. 配置 settings.py 文件 为了支持 RESTful API 开发，在项目的 `settings.py` 文件中需要安装 `rest_framework` 并将其添加到已启用的应用列表中： ```python INSTALLED_APPS = [ ... 'rest_framework', 'myfirstapp', # 自定义应用名称 ] ``` 上述设置确保了项目能够识别并加载 `djangorestframework` 所需的功能模块[^3]。 #### 3. 编写 POST 接口逻辑 对于简单的 POST 请求处理，可以通过自定义函数实现接口功能。下面展示了一个基本的 POST 接口示例代码[^2]: ```python from django.http import JsonResponse from django.views.decorators.csrf import csrf_exempt @csrf_exempt def post(request): if request.method == "POST": try: request_body = request.body.decode('utf-8') # 获取原始数据流 data = json.loads(request_body) # 转换为字典对象 query_value = data.get("query", "") # 提取参数 response_data = { "code": 200, "message": f"查询 {query_value} 成功" } except Exception as e: response_data = { "code": 400, "message": str(e) } return JsonResponse(response_data) ``` #### 4. 使用 rest_framework 进一步优化接口设计 如果希望更高效地管理复杂的 API 结构，则推荐采用 DRF（Django Rest Framework），它提供了序列化器和路由等功能来简化开发过程[^4]。以下是基于 DRF 实现相同功能的例子: ##### 定义 Serializer 类型 ```python from rest_framework import serializers class QuerySerializer(serializers.Serializer): query = serializers.CharField(max_length=100, required=True) ``` ##### 构建 ViewSet 或 GenericAPIView ```python from rest_framework.response import Response from rest_framework.views import APIView class PostQuery(APIView): def post(self, request, *args, **kwargs): serializer = QuerySerializer(data=request.data) if not serializer.is_valid(): return Response({"error":serializer.errors}, status=400) validated_query = serializer.validated_data['query'] result_message = {'status': 'success', 'data':f'You queried:{validated_query}'} return Response(result_message,status=200) ``` ##### 注册 URL 路由 最后还需要把新建立好的 view 添加至 urls.py 当中的路径映射表里头去。 ```python urlpatterns = [ path('api/post-query/', views.PostQuery.as_view(), name='post-query'), ] ``` 以上即完成了整个流程说明，从基础环境搭建直至高级框架运用都进行了详细介绍。 ---