Django RESTful API 设计：创建健壮而可扩展的 API

遵循 REST 原则

RESTful API 严格遵循 REST（表述性状态转移）原则，以确保一致性和可预测性。这些原则包括：

• 均匀接口：所有资源都使用一致的资源标识符 (URI) 和操作。
• 无状态：每次请求都包含所有必要的信息，服务器不会存储客户端状态信息。
• 缓存：响应头指定内容是否可缓存，提高性能。
• 按需分层：API 可以分层，以便客户端仅获取所需数据。

示例：

# CRUD 操作的 URI
urlpatterns = [
    path("todos/", TodoListCreateAPIView.as_view()),
    path("todos/<int:pk>/", TodoRetrieveUpdateDestroyAPIView.as_view()),
]

选择合适的视图类

Django REST Framework 提供了各种视图类，用于处理不同的 HTTP 操作。选择合适的视图类可提高代码的可维护性和可重复使用性。

示例：

from rest_framework.views import APIView
from rest_framework.response import Response

class TodoListAPIView(APIView):
    def get(self, request):
        # 获取所有待办事项
        todos = Todo.objects.all()
        serialized_todos = TodoSerializer(todos, many=True)
        return Response(serialized_todos.data)

使用序列化器

序列化器负责将模型实例转换为可通过 API 访问的数据结构。它们定义了要序列化的字段，并可以执行验证和数据验证。

示例：

from rest_framework.serializers import ModelSerializer

class TodoSerializer(ModelSerializer):
    class Meta:
        model = Todo
        fields = ("id", "title", "description", "completed")

实施身份验证和授权

保护 API 免受未经授权的访问至关重要。Django REST Framework 提供开箱即用的身份验证和授权功能，允许您根据需要实现不同的策略。

示例：

REST_FRAMEWORK = {
    "DEFAULT_AUTHENTICATION_CLASSES": [
        "rest_framework.authentication.TokenAuthentication",
    ],
    "DEFAULT_PERMISSION_CLASSES": [
        "rest_framework.permissions.IsAuthenticated",
    ]
}

错误处理

优雅地处理错误对于提供用户友好的 API 体验至关重要。Django REST Framework 提供了异常处理机制，可返回标准化错误响应。

示例：

from rest_framework.exceptions import ValidationError

class TodoSerializer(ModelSerializer):
    def validate(self, data):
        # 检查标题是否已存在
        if Todo.objects.filter(title=data["title"]).exists():
            raise ValidationError("Title already exists")

        # 其他验证
        return data

版本控制

随着 API 的发展，版本控制对于管理 API 的不同版本至关重要。Django REST Framework 提供了版本控制功能，允许您为 API 创建多个版本。

示例：

VERSIONING_CLASS = "rest_framework.versioning.NamespaceVersioning"

测试和文档

编写单元测试和文档对于维护健壮的可扩展 API 至关重要。Django REST Framework 提供了内置的测试客户端，使测试变得容易。

示例：

from rest_framework.test import APIClient
from todos.models import Todo

def test_create_todo():
    client = APIClient()
    data = {"title": "New Todo", "description": "Description"}
    response = client.post("/todos/", data, format="json")
    assert response.status_code == 201
    assert Todo.objects.filter(title="New Todo").exists()

结论

遵循最佳实践、采用适当的技术和实施安全措施对于构建健壮、可扩展和用户友好的 Django RESTful API 至关重要。通过仔细注意 API 设计，您可以创建满足现代 Web 应用程序需求的可靠且灵活的 API。