settings.py

Django REST framework 是一个强大的 REST 框架，用于构建 Web API。本文将为您介绍 Django REST framework 的基础知识。

安装 Django REST framework

首先，您需要安装 Django REST framework。可以通过以下命令进行安装：

pip install djangorestframework

快速开始

以下是一个简单的 Django REST framework 项目示例：


INSTALLED_APPS = [
    ...
    'rest_framework',
    ...
]

# urls.py
from django.urls import path
from . import views

urlpatterns = [
    path('api/', views.api_root, name='api_root'),
]

创建视图

创建一个视图来处理 API 请求：

# views.py
from rest_framework.response import Response
from rest_framework.decorators import api_view

@api_view(['GET'])
def api_root(request, format=None):
    return Response({
        'users': reverse('user-list', request=request, format=format),
        'snippets': reverse('snippet-list', request=request, format=format)
    })

创建序列化器

序列化器用于将 Python 对象转换为 JSON 格式：

# serializers.py
from rest_framework import serializers
from .models import User

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('id', 'username', 'email')

创建模型

创建一个 Django 模型来存储用户信息：

# models.py
from django.db import models

class User(models.Model):
    username = models.CharField(max_length=100)
    email = models.EmailField()

    def __str__(self):
        return self.username

创建 URL

创建 URL 来访问 API：

# urls.py
from django.urls import path
from . import views

urlpatterns = [
    path('api/users/', views.UserList.as_view(), name='user-list'),
]

创建视图集

视图集是一个视图的集合，它简化了 API 的创建过程：

# views.py
from rest_framework import viewsets
from .models import User
from .serializers import UserSerializer

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

运行服务器

运行 Django 服务器来启动您的 API：

python manage.py runserver

现在，您可以通过以下 URL 访问用户列表 API：

http://127.0.0.1:8000/api/users/

更多关于 Django REST framework 的信息，请访问我们的官方文档。

如果您想了解更多关于 Django REST framework 的进阶使用，可以查看以下教程：