如何在 RESTful API 中使用 Django 框架-JavaScript中文网-JavaScript教程资源分享门户

随着互联网技术的不断发展，前端技术越来越成熟，而 RESTful API 也被越来越广泛地应用于各种应用场景中。Django 是一个强大的 Web 框架，具备良好的数据模型抽象能力以及便捷的 URL 映射机制，使得它在 RESTful API 的开发中也有着广泛的应用。

本文将带你深入了解在 RESTful API 中如何使用 Django 框架，包括安装和创建 Django 项目、创建 Django 应用程序、建立数据库模型、编写视图函数以及进行 API 的测试等。

安装和创建 Django 项目

首先，我们需要安装 Django 框架。在终端中输入以下命令：

$ pip install django

接着，在终端中创建一个 Django 项目并进入项目根目录：

$ django-admin startproject myproject
$ cd myproject

在项目目录下，我们可以看到以下文件：

myproject/
    manage.py
    myproject/
        __init__.py
        settings.py
        urls.py
        asgi.py
        wsgi.py

其中，manage.py 是 Django 项目的命令行工具，用于执行各种 Django 命令。myproject 目录是 Django 项目的主目录，包含了项目的配置文件和 URL 映射文件。

创建 Django 应用程序

在 Django 项目中，可以创建多个应用程序来实现不同的功能。在终端中输入以下命令，创建一个名为 myapp 的应用程序：

$ python manage.py startapp myapp

在项目目录中，会出现一个新的名为 myapp 的目录，包含了该应用程序的代码文件。为了让 Django 识别该应用程序，需要在 settings.py 文件的 INSTALLED_APPS 列表中添加应用程序的名称：

// javascriptcn.com 代码示例
# myproject/settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    'myapp',  # 新添加的应用程序名称
]

建立数据库模型

在 Django 中，使用模型来描述应用程序中的数据结构。模型是 Django 中的核心概念之一，它提供了一种便捷的方式来操作数据库。

下面是一个简单的模型定义示例，用于描述一个 Todo 任务：

# myapp/models.py

from django.db import models

class Todo(models.Model):
    title = models.CharField(max_length=200)
    completed = models.BooleanField(default=False)

该模型包含了两个字段：title（标题）和 completed（是否完成）。CharField 是一个字符串类型的字段，BooleanField 是一个布尔类型的字段。

完成模型定义后，需要运行以下命令来在数据库中创建该表：

$ python manage.py makemigrations
$ python manage.py migrate

编写视图函数

在 Django 中，视图函数是负责处理 HTTP 请求并返回 HTTP 响应的函数。下面是一个处理 GET 请求并返回所有 Todo 任务的视图函数：

// javascriptcn.com 代码示例
# myapp/views.py

from django.http import JsonResponse
from .models import Todo

def todo_list(request):
    todos = Todo.objects.all()
    data = {
        'todos': [dict(id=todo.id, title=todo.title, completed=todo.completed) for todo in todos]
    }
    return JsonResponse(data)

该视图函数首先从数据库中获取所有的 Todo 任务，然后把它们存储在一个字典中并返回一个 JsonResponse 对象。JsonResponse 会把字典转换成 JSON 格式的数据，并设置正确的 Content-Type 头。

完成视图函数的编写后，需要在 urls.py 文件中定义一个 URL 映射来把请求和该视图函数关联起来。下面是一个定义 URL 映射的示例：

# myapp/urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('todos/', views.todo_list, name='todo_list'),
]

该 URL 映射会把 /todos/ 请求映射到 todo_list 函数。

进行 API 的测试

启动 Django 服务器：

$ python manage.py runserver

在浏览器中访问 http://localhost:8000/myapp/todos/，可以看到浏览器返回了 JSON 格式的数据，其中包含了所有的 Todo 任务。

在终端中，可以使用 curl 命令测试该 API：

$ curl http://localhost:8000/myapp/todos/

该命令会返回以下 JSON 格式的数据：

// javascriptcn.com 代码示例
{
  "todos": [
    {
      "id": 1,
      "title": "Learn Django",
      "completed": false
    },
    {
      "id": 2,
      "title": "Build a RESTful API",
      "completed": false
    }
  ]
}

总结

本文介绍了在 RESTful API 中使用 Django 框架的基本步骤，包括创建 Django 项目、创建 Django 应用程序、建立数据库模型、编写视图函数以及进行 API 的测试等。通过本文的学习，相信你已经掌握了如何使用 Django 开发 RESTful API 的基本技能。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/652ef2977d4982a6eb00f1ee