如何使用Django REST Framework开发API

如果你掌握了领域的基础知识，就能够驾驭任何技术，作为开发者提升自己的技能水平，并创造出更优质的产品。对于希望学习如何使用 Django REST Framework（DRF）开发 API 的初学者来说，这篇文章将是一个有用的指南。

Django REST Framework 是一个强大而灵活的工具包，用于在 Django 上RESTful API 则是遵循 REST 约束的 Web 服务。通过掌握 DRF 和 RESTful API 的开发技能，您可以轻松连接应用程序的前后端部分，构建各种类型的产品。

为什么选择 Django REST Framework 开发 API？

Django 是一个高级的 Python Web 框架，旨在简化复杂数据库驱动网站的开发。它支持快速开发和干净、实用的设计。而 Django REST Framework 在 Django 的基础上扩展了功能，专注于构建 Web API。以下是使用 DRF 的一些主要优势：

快速开发：通过通用视图和序列化器，快速创建与数据库模型紧密映射的 API。
灵活性：支持多种身份验证机制、权限控制和请求速率限制（Throttling）。
可扩展性：遵循 Django 的 DRY（Don’t Repeat Yourself）原则，强调模块化和代码重用。
可维护性：提供可浏览的 API 接口，便于开发者调试和测试。
安全性：内置多种安全机制，确保 API 的安全性。

DRF 的这些特性使得开发者能够在健壮性和简单性之间找到平衡，显著加速开发过程。

Django 中 API 开发的分步指南

以下是使用 Django REST Framework 开发 API 的详细步骤：

1. 设置开发环境

首先，确保安装了最新版本的 Python 和必要的开发工具。以下是配置环境的基本步骤：

# 克隆 pyenv 仓库
git clone https://github.com/pyenv/pyenv.git ~/.pyenv

# 设置环境变量
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc# 启用 pyenv
echo -e 'if command -v pyenv 1>/dev/null 2>&1; thenn eval "$(pyenv init --path)"nfi' >> ~/.bashrc
source ~/.bashrc# 安装 Python 最新稳定版本
pyenv install 3.7.4# 创建虚拟环境
pyenv virtualenv 3.7.4 my_project_env

2. 创建 Django 项目

创建项目文件夹并初始化 Django 项目：

mkdir my_project && cd my_project
django-admin startproject my_project .

3. 安装必要的依赖包

在项目目录下创建 requirements.txt 文件，并添加所需的依赖包，例如：

Django>=3.2

djangorestframework

psycopg2

然后运行以下命令安装依赖：

pip install -r requirements.txt

4. 配置数据库

推荐使用 PostgreSQL 作为数据库。在 settings.py 文件中配置数据库连接：

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'my_database',
        'USER': 'my_user',
        'PASSWORD': 'my_password',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}

运行以下命令初始化数据库：

python manage.py migrate

5. 创建应用程序

使用以下命令创建一个新的 Django 应用程序：

python manage.py startapp blog

将新应用添加到 INSTALLED_APPS 中：

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

测试驱动开发（TDD）

测试驱动开发（TDD）是一种在实现业务逻辑之前先编写测试的开发方法。它的主要优点包括：

提供快速反馈，减少调试时间。
生成高质量、可维护的代码。
确保代码的功能符合预期。

在 Django 中，您可以使用以下命令运行测试：

python manage.py test

构建和测试 API

1. 定义模型

在 models.py 中定义数据模型，例如：

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=100)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

运行以下命令生成并应用迁移：

python manage.py makemigrations
python manage.py migrate

2. 创建序列化器

在 serializers.py 中定义序列化器：

from rest_framework import serializers
from .models import Post

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fields = '__all__'

3. 定义视图

在 views.py 中定义 API 视图：

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Post
from .serializers import PostSerializer

class PostListView(APIView):
    def get(self, request):
        posts = Post.objects.all()
        serializer = PostSerializer(posts, many=True)
        return Response(serializer.data)

4. 配置路由

在 urls.py 中添加路由：

from django.urls import path
from .views import PostListView

urlpatterns = [
    path('posts/', PostListView.as_view(), name='post-list'),
]

5. 测试 API

启动开发服务器并测试 API：

python manage.py runserver

访问 http://127.0.0.1:8000/posts/ 查看结果。

可浏览的 API 和版本控制

Django REST Framework 提供了一个可浏览的 API 界面，便于开发者调试和测试。此外，DRF 支持多种版本控制方法，例如基于 URL 路径的版本控制：

urlpatterns = [
    path('v1/posts/', PostListView.as_view(), name='post-list-v1'),
]

总结

通过 Django REST Framework，您可以快速构建功能强大且安全的 API。它提供了丰富的功能，包括认证、权限控制、分页、缓存等，帮助开发者高效地完成项目开发。无论是初学者还是经验丰富的开发者，DRF 都是一个值得学习和使用的工具。

原文链接: https://djangostars.com/blog/rest-apis-django-development/