编写你的第一个Django REST API接口

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

环境准备

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

  1. 安装virtualenv和virtualenvwrapper:

    bash 复制代码
    pip install virtualenv virtualenvwrapper
  2. 找到virtualenvwrapper.sh的位置,并将其添加到你的环境变量中。通常,这个文件位于/usr/local/bin/,但可能因系统而异。

  3. .bash_profile.bashrc中添加以下内容:

    bash 复制代码
    export WORKON_HOME=$HOME/.virtualenvs
    source /usr/local/bin/virtualenvwrapper.sh
  4. 重新加载配置文件以应用更改:

    bash 复制代码
    source ~/.bash_profile
  5. 创建一个名为mytest的虚拟环境,并指定Python版本:

    bash 复制代码
    mkvirtualenv -p /usr/local/bin/python3 mytest

项目准备

  1. 安装Django和Django REST Framework:

    bash 复制代码
    pip install django djangorestframework
  2. 创建一个新的Django项目和应用:

    bash 复制代码
    django-admin.py startproject mysite
    django-admin.py startapp books
  3. 同步数据库:

    bash 复制代码
    python3 manage.py makemigrations
    python3 manage.py migrate

序列化数据

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

python 复制代码
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来创建我们的视图。

python 复制代码
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模式,并注册我们的视图。

python 复制代码
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

python 复制代码
INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework_swagger',
]

测试API

启动Django开发服务器:

bash 复制代码
python3 manage.py runserver 8000

现在,你可以通过curl或者直接在浏览器中访问http://127.0.0.1:8000/users/来测试你的API。

结论

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

相关推荐
white-persist24 分钟前
VSCode 快捷键大全:从设计理念到场景化高效运用(详细解析)(文章末尾有vim快捷键大全)
linux·ide·vscode·python·编辑器·系统安全·vim
liliangcsdn28 分钟前
python threading异步并发调用示例
python
计算机毕设匠心工作室30 分钟前
【python大数据毕设实战】全面皮肤病症状数据可视化分析系统、Hadoop、计算机毕业设计、包括数据爬取、数据分析、数据可视化、机器学习、实战教学
后端·python·mysql
码界奇点1 小时前
基于Python与Pygame的多功能游戏系统设计与实现
python·游戏·毕业设计·pygame·源代码管理
万邦科技Lafite1 小时前
一键获取淘宝店铺所有商品信息,实时监控商品数据
开发语言·数据库·python·api·开放api·电商开放平台·淘宝开放平台
小糖学代码1 小时前
LLM系列:1.python入门:2.数值型对象
人工智能·python·ai
非鱼feiyu2 小时前
自关联数据表查询优化实践:以 Django + 递归 CTE 构建树结构为例
数据库·后端·django
零日失眠者2 小时前
这5个Python库一旦掌握就离不开
后端·python
用户8356290780512 小时前
如何使用 Python 从 Word 文档中批量提取表格数据
后端·python
Jerryhut2 小时前
sklearn函数总结四——归一化和标准化
人工智能·python·机器学习·jupyter·sklearn