如何使用 Django Rest Framework 创建基本 API？

Django Rest Framework（DRF）是一个功能强大而灵活的工具，它使得开发 RESTful API 变得容易。本文将介绍如何使用 Django Rest Framework 创建基本 API。

前提条件

在使用 Django Rest Framework 之前，需要先安装好 Django。

安装 Django Rest Framework

安装 Django Rest Framework 很简单。只需要在命令行中执行以下命令：

pip install djangorestframework

创建 Django 项目

创建 Django 项目很容易。只需要在命令行中执行以下命令：

django-admin startproject myproject

其中，myproject 是你所要创建的项目名称。

创建 Django 应用

创建 Django 应用也很简单。只需要在命令行中执行以下命令：

cd myproject
python manage.py startapp myapp

其中，myapp 是你所要创建的应用程序名称。

配置 Django Rest Framework

在 myproject/settings.py 中添加以下代码：

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

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.AllowAny',
    ],
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.BasicAuthentication',
    ],
}

其中，AllowAny 表示允许任何人访问 API，SessionAuthentication 表示使用 Django 的 session 认证方式，BasicAuthentication 表示使用基本认证方式。

创建 API 视图

在 myapp/views.py 中添加以下代码：

from django.http import JsonResponse
from rest_framework.decorators import api_view

@api_view(['GET'])
def hello(request):
    data = {
        'message': 'hello world'
    }
    return JsonResponse(data)

其中，@api_view 表示这是一个 RESTful API 视图，并且只允许 GET 请求。

创建 URL

在 myapp/urls.py 中添加以下代码：

from django.urls import path
from .views import hello

urlpatterns = [
    path('hello/', hello),
]

其中，path('hello/', hello) 表示将 /hello/ 映射到 hello 视图函数。

运行 Django 服务器

在命令行中执行以下命令：

python manage.py runserver

在浏览器中访问 http://127.0.0.1:8000/hello/，即可看到以下输出：

{
    "message": "hello world"
}

总结

本文介绍了如何使用 Django Rest Framework 创建基本 API。首先，安装 Django Rest Framework，然后创建 Django 项目和应用，接着配置 Django Rest Framework，创建 API 视图和 URL，最后运行 Django 服务器即可。