优享资讯 | 编写你的第一个Django REST API接口

掘金后端 ( ) • 2024-04-17 16:39

Django REST Framework（DRF）是Django的一个强大扩展，它使得创建和维护RESTful API变得简单而直观。DRF的丰富特性集合，包括认证、权限、限流和自动序列化等，为开发者提供了一个全面的解决方案，用于构建高效、可扩展的Web服务。

环境准备

在开始之前，确保你的开发环境中已经安装了Python和pip。接下来，我们将使用virtualenv和virtualenvwrapper来创建一个隔离的Python环境。

安装virtualenv和virtualenvwrapper：

pip install virtualenv virtualenvwrapper

找到virtualenvwrapper.sh的位置，并将其添加到你的环境变量中。通常，这个文件位于/usr/local/bin/，但可能因系统而异。

在.bash_profile或.bashrc中添加以下内容：

export WORKON_HOME=$HOME/.virtualenvs
source /usr/local/bin/virtualenvwrapper.sh

重新加载配置文件以应用更改：
```
source ~/.bash_profile
```
创建一个名为mytest的虚拟环境，并指定Python版本：
```
mkvirtualenv -p /usr/local/bin/python3 mytest
```

项目准备

安装Django和Django REST Framework：
```
pip install django djangorestframework
```

创建一个新的Django项目和应用：

django-admin.py startproject mysite
django-admin.py startapp books

同步数据库：

python3 manage.py makemigrations
python3 manage.py migrate

序列化数据

在books/serializers.py中，我们将定义如何将Django模型转换为JSON格式的数据。

from django.contrib.auth.models import User, Group
from rest_framework import serializers

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

class GroupSerializer(serializers.ModelSerializer):
    class Meta:
        model = Group
        fields = ('url', 'name')

编写视图

在books/views.py中，我们将使用DRF的ModelViewSet来创建我们的视图。

from rest_framework import viewsets
from .serializers import UserSerializer, GroupSerializer

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

class GroupViewSet(viewsets.ModelViewSet):
    serializer_class = GroupSerializer
    queryset = Group.objects.all()

定义URLs

在mysite/urls.py中，我们将定义URL模式，并注册我们的视图。

from django.conf.urls import url
from rest_framework import routers
from . import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

urlpatterns = [
    url('', include(router.urls)),
    url('^api-auth/', include('rest_framework.urls')),
]

配置Django Settings

在settings.py中，确保已经安装了DRF和rest_framework_swagger。

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

测试API

启动Django开发服务器：

python3 manage.py runserver 8000

现在，你可以通过curl或者直接在浏览器中访问http://127.0.0.1:8000/users/来测试你的API。在这里插入图片描述

结论

通过上述步骤，你已经成功创建了你的第一个Django REST API接口。这个过程展示了如何从环境设置到序列化、视图编写和URL定义的基本流程。随着你对Django REST Framework的进一步学习，你将能够构建更加复杂和强大的API，满足各种业务需求。