如何借助Django来编写一个Python Web API

开发 后端
Django 是 Python API 开发中最流行的框架之一,在这个教程中,我们来学习如何使用它。本文演示了一个简单的 API,通过它可以使用 HTTP 协议的 GET 方法来从服务器获取数据。

[[312568]]

Django 是 Python API 开发中最流行的框架之一,在这个教程中,我们来学习如何使用它。

Django 所有 Web 框架中最全面的,也是最受欢迎的一个。自 2005 年以来,其流行度大幅上升。

Django 是由 Django 软件基金会维护,并且获得了社区的大力支持,在全球拥有超过 11,600 名成员。在 Stack Overflow 上,约有 191,000 个带 Django 标签的问题。Spotify、YouTube 和 Instagram 等都使用 Django 来构建应用程序和数据管理。

本文演示了一个简单的 API,通过它可以使用 HTTP 协议的 GET 方法来从服务器获取数据。

构建一个项目

首先,为你的 Django 应用程序创建一个目录结构,你可以在系统的任何位置创建:

  1. $ mkdir myproject
  2. $ cd myproject

然后,在项目目录中创建一个虚拟环境来隔离本地包依赖关系:

  1. $ python3 -m venv env
  2. $ source env/bin/activate

在 Windows 上,使用命令 env\Scripts\activate 来激活虚拟环境。

安装 Django 和 Django REST framework

然后,安装 Django 和 Django REST 模块:

  1. $ pip3 install django
  2. $ pip3 install djangorestframework

实例化一个新的 Django 项目

现在你的应用程序已经有了一个工作环境,你必须实例化一个新的 Django 项目。与 Flask 这样微框架不同的是,Django 有专门的命令来创建(注意第一条命令后的 . 字符)。

  1. $ django-admin startproject tutorial .
  2. $ cd tutorial
  3. $ django-admin startapp quickstart

Django 使用数据库来管理后端,所以你应该在开始开发之前同步数据库,数据库可以通过 manage.py 脚本管理,它是在你运行 django-admin 命令时创建的。因为你现在在 tutorial 目录,所以使用 ../ 符号来运行脚本,它位于上一层目录:

  1. $ python3 ../manage.py makemigrations
  2. No changes detected
  3. $ python4 ../manage.py migrate
  4. Operations to perform:
  5. Apply all migrations: admin, auth, contenttypes, sessions
  6. Running migrations:
  7. Applying contenttypes.0001_initial... OK
  8. Applying auth.0001_initial... OK
  9. Applying admin.0001_initial... OK
  10. Applying admin.0002_logentry_remove_auto_add... OK
  11. Applying admin.0003_logentry_add_action_flag_choices... OK
  12. Applying contenttypes.0002_remove_content_type_name... OK
  13. Applying auth.0002_alter_permission_name_max_length... OK
  14. Applying auth.0003_alter_user_email_max_length... OK
  15. Applying auth.0004_alter_user_username_opts... OK
  16. Applying auth.0005_alter_user_last_login_null... OK
  17. Applying auth.0006_require_contenttypes_0002... OK
  18. Applying auth.0007_alter_validators_add_error_messages... OK
  19. Applying auth.0008_alter_user_username_max_length... OK
  20. Applying auth.0009_alter_user_last_name_max_length... OK
  21. Applying auth.0010_alter_group_name_max_length... OK
  22. Applying auth.0011_update_proxy_permissions... OK
  23. Applying sessions.0001_initial... OK

在 Django 中创建用户

创建一个名为 admin,示例密码为 password123 的初始用户:

  1. $ python3 ../manage.py createsuperuser \
  2. --email admin@example.com \
  3. --username admin

在提示时创建密码。

在 Django 中实现序列化和视图

为了使 Django 能够将信息传递给 HTTP GET 请求,必须将信息对象转化为有效的响应数据。Django 为此实现了“序列化类” serializers

在你的项目中,创建一个名为 quickstart/serializers.py 的新模块,使用它来定义一些序列化器,模块将用于数据展示:

  1. from django.contrib.auth.models import User, Group
  2. from rest_framework import serializers
  3.  
  4. class UserSerializer(serializers.HyperlinkedModelSerializer):
  5. class Meta:
  6. model = User
  7. fields = ['url', 'username', 'email', 'groups']
  8.  
  9. class GroupSerializer(serializers.HyperlinkedModelSerializer):
  10. class Meta:
  11. model = Group
  12. fields = ['url', 'name']

Django 中的视图是一个接受 Web 请求并返回 Web 响应的函数。响应可以是 HTML、HTTP 重定向、HTTP 错误、JSON 或 XML 文档、图像或 TAR 文件,或者可以是从 Internet 获得的任何其他内容。要创建视图,打开 quickstart/views.py 并输入以下代码。该文件已经存在,并且其中包含一些示例文本,保留这些文本并将以下代码添加到文件中:

  1. from django.contrib.auth.models import User, Group
  2. from rest_framework import viewsets
  3. from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
  4.  
  5. class UserViewSet(viewsets.ModelViewSet):
  6. """
  7. API 允许查看或编辑用户
  8. """
  9. queryset = User.objects.all().order_by('-date_joined')
  10. serializer_class = UserSerializer
  11.  
  12. class GroupViewSet(viewsets.ModelViewSet):
  13. """
  14. API 允许查看或编辑组
  15. """
  16. queryset = Group.objects.all()
  17. serializer_class = GroupSerializer

使用 Django 生成 URL

现在,你可以生成 URL 以便人们可以访问你刚起步的 API。在文本编辑器中打开 urls.py 并将默认示例代码替换为以下代码:

  1. from django.urls import include, path
  2. from rest_framework import routers
  3. from tutorial.quickstart import views
  4.  
  5. router = routers.DefaultRouter()
  6. router.register(r'users', views.UserViewSet)
  7. router.register(r'groups', views.GroupViewSet)
  8.  
  9. # 使用自动路由 URL
  10. # 还有登录 URL
  11. urlpatterns = [
  12. path('', include(router.urls)),
  13. path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
  14. ]

调整你的 Django 项目设置

这个示例项目的设置模块存储在 tutorial/settings.py 中,因此在文本编辑器中将其打开,然后在 INSTALLED_APPS 列表的末尾添加 rest_framework

  1. INSTALLED_APPS = [
  2. ...
  3. 'rest_framework',
  4. ]

测试 Django API

现在,你可以测试构建的 API。首先,从命令行启动内置服务器:

  1. $ python3 manage.py runserver

你可以通过使用 curl 导航至 URL http://localhost:8000/users 来访问 API:

  1. $ curl --get http://localhost:8000/users/?format=json
  2. [{"url":"http://localhost:8000/users/1/?format=json","username":"admin","email":"admin@example.com","groups":[]}]

使用 Firefox 或你选择的开源浏览器

 

一个简单的 Django API

有关使用 Django 和 Python 的 RESTful API 的更多深入知识,参考出色的 Django 文档

为什么要使用 Djago?

Django 的主要优点:

  1. Django 社区的规模正在不断扩大,因此即使你做一个复杂项目,也会有大量的指导资源。
  2. 默认包含模板、路由、表单、身份验证和管理工具等功能,你不必寻找外部工具,也不必担心第三方工具会引入兼容性问题。
  3. 用户、循环和条件的简单结构使你可以专注于编写代码。
  4. 这是一个成熟且经过优化的框架,它非常快速且可靠。

Django 的主要缺点:

  1. Django 很复杂!从开发人员视角的角度来看,它可能比简单的框架更难学。
  2. Django 有一个很大的生态系统。一旦你熟悉它,这会很棒,但是当你深入学习时,它可能会令人感到无所适从。

对你的应用程序或 API 来说,Django 是绝佳选择。下载并熟悉它,开始开发一个迷人的项目! 

责任编辑:庞桂玉 来源: Linux中国
相关推荐

2019-12-23 10:00:52

PythonFlaskPython Web

2021-04-07 13:38:27

Django项目视图

2020-01-16 11:42:45

PyramidCornicePython Web

2022-02-01 16:02:03

PythonWeb服务器

2017-12-12 15:24:32

Web Server单线程实现

2013-07-01 11:01:22

API设计API

2018-09-08 08:41:21

Python 3API框架API Star

2023-12-12 08:08:17

插件PRPulsar

2016-01-06 09:57:23

编写PHP扩展

2015-08-19 09:29:35

Git协议编写

2018-10-11 21:00:18

2023-09-21 22:43:17

Django框架

2020-09-22 07:50:23

API接口业务

2022-07-26 08:14:16

注册中心ProviderConsumer

2021-01-01 19:30:21

Python编程语言

2024-03-08 12:45:00

C#Web服务器

2018-11-26 08:06:24

API网关亿级

2022-03-14 09:35:43

Pythonhttpx

2017-01-12 22:36:30

2021-07-06 14:36:05

RustLinux内核模块
点赞
收藏

51CTO技术栈公众号