在现代 Web 开发中，RESTful API 已经成为了一种非常流行的 API 设计方式。它的优点包括灵活性、可扩展性、易于缓存等等。Django 是一个强大的 Web 开发框架，它提供了非常方便的工具来创建 RESTful API。在本文中，我们将介绍如何使用 Django 来建立 RESTful API，并提供示例代码。
什么是 RESTful API？
RESTful API 是一种基于 HTTP 协议的 API 设计方式，它使用 HTTP 动词来表示操作，并使用 URI 来表示资源。RESTful API 的核心思想是将数据和操作分离开来，数据由资源表示，操作由 HTTP 动词表示。
RESTful API 有以下几个特点：
- 资源是通过 URI 来表示的，URI 应该是唯一的。
- 操作是通过 HTTP 动词来表示的，常见的 HTTP 动词有 GET、POST、PUT、DELETE 等。
- RESTful API 应该无状态，每个请求应该包含足够的信息来完成操作。
- RESTful API 应该使用标准的 HTTP 状态码来表示操作结果。
Django REST framework 简介
Django REST framework 是一个基于 Django 的强大的 RESTful API 框架。它提供了非常方便的工具来创建 RESTful API，包括序列化器、视图、路由、认证、权限等等。
使用 Django REST framework，我们可以非常方便地创建符合 RESTful API 设计规范的 API。下面我们将介绍如何使用 Django REST framework 来创建 RESTful API。
创建 Django 项目
首先我们需要创建一个 Django 项目。可以使用以下命令来创建一个新的 Django 项目：
- ------------ ------------ ---------
其中 myproject 是项目名称。创建完成后，我们可以进入项目目录：
- -- ---------
安装 Django REST framework
安装 Django REST framework 非常简单，可以使用以下命令来安装：
- --- ------- -------------------
安装完成后，我们需要将它添加到项目的 INSTALLED_APPS 中：
- ---------------------
-------------- - -
- ---
-----------------
-创建模型
在创建 API 之前，我们需要定义数据模型。这里我们以一个简单的博客系统为例，创建一个文章模型：
- ---------------
---- --------- ------ ------
----- -------------------
----- - --------------------------------
------- - ------------------
---------- - ---------------------------------------
---------- - -----------------------------------这个模型定义了一个文章，包括标题、内容、创建时间和更新时间。
创建序列化器
接下来我们需要创建一个序列化器，用于将模型转换为 JSON 格式。序列化器是 Django REST framework 的核心组件，它负责将模型转换为 JSON 格式，并将 JSON 格式转换为模型。
- --------------------
---- -------------- ------ -----------
---- ------------ ------ ----
----- --------------------------------------------
----- -----
----- - ----
------ - ------ -------- ---------- ------------- -------------这个序列化器定义了一个 PostSerializer 类，继承自 serializers.ModelSerializer。它指定了模型为 Post，指定了需要序列化的字段。
创建视图
接下来我们需要创建一个视图，用于处理 HTTP 请求。视图决定了 API 的行为，包括接受请求、验证请求、处理请求、返回响应等等。Django REST framework 提供了很多种视图，包括基于函数的视图、基于类的视图、通用视图等等。
这里我们使用基于类的视图，创建一个文章列表视图：
- --------------
---- -------------- ------ --------
---- ------------ ------ ----
---- ----------------- ------ --------------
----- -------------------------------------
-------- - ------------------
---------------- - --------------这个视图定义了一个 PostList 类，继承自 generics.ListCreateAPIView。它指定了查询集为 Post.objects.all()，指定了序列化器为 PostSerializer。
创建路由
最后我们需要创建一个路由，将视图绑定到 URI 上。Django REST framework 提供了非常方便的路由工具，可以自动将视图绑定到 URI 上。
- -----------------
---- ----------- ------ ----- -------
---- -------------- ------ -------
---- ----------- ------ --------
------ - -----------------------
------------------------- ---------
----------- - -
-------- ----------------------
-这个路由定义了一个默认路由器 router，将 PostList 视图绑定到 /posts URI 上。最后将路由器添加到 urlpatterns 中，即可完成路由配置。
测试 API
现在我们已经完成了一个简单的 RESTful API，可以使用以下命令启动开发服务器进行测试：
- ------ --------- ---------
开发服务器启动后，可以访问 http://127.0.0.1:8000/posts 来查看文章列表。我们可以使用 curl 命令来测试 API：
- ---- ----------------------------
如果一切正常，应该会返回一个 JSON 格式的文章列表。
总结
在本文中，我们介绍了如何使用 Django REST framework 来创建 RESTful API。首先我们定义了数据模型，然后创建了序列化器、视图和路由，最后测试了 API。Django REST framework 提供了非常方便的工具来创建符合 RESTful API 设计规范的 API，可以大大提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/667fdc19dc1ed1a61beabdd6