用 Django 开发一个 Python Web API的方法步骤

下面是用 Django 开发一个 Python Web API的方法步骤的完整攻略。

1. 创建 Django 项目

首先我们需要创建一个 Django 项目，打开控制台，输入以下命令：

django-admin startproject project_name

其中，project_name 可以替换为你想要创建的项目名称。

2. 创建 Django App

接下来需要创建一个 Django App，用于专门处理 API 相关的逻辑。在控制台中切换到项目目录，输入以下命令：

python manage.py startapp api_app

其中，api_app 可以替换成你想要创建的 App 名称。

3. 编写 API 视图函数

在创建的 api_app 中，我们需要定义 API 视图函数来处理 API 请求。在 api_app 中创建 views.py 文件，创建一个示例函数如下：

from django.http import JsonResponse

def hello(request):
    return JsonResponse({'message': 'hello world'})

该函数会接收一个请求对象 request，处理请求，返回一个 JSON 数据。

4. 配置 URL 路由

接下来需要配置 URL 路由，使得 API 请求能够通过 URL 地址访问到对应的视图函数。在 api_app 中创建 urls.py 文件，创建一个示例路由如下：

from django.urls import path
from . import views

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

该路由会将以'hello/'开头的请求转发给 hello 视图函数。

5. 配置项目 URL

最后，在项目目录中的 urls.py 文件中，将 api_app 的 URL 路由配置到项目 URL 中，如下：

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api_app.urls')), # 配置 api_app URL
]

这样，当请求 '/api/hello/' 地址时，就会访问到 api_app 中定义的 hello 视图函数。

示例1：返回查询字符串参数

在上面的示例中，我们返回了一个简单的 JSON 数据，没有处理任何参数。现在我们来看一下如何接收和处理查询字符串参数。

在 api_app 中创建一个新的视图函数，处理查询字符串参数，并返回相应的 JSON 数据：

from django.http import JsonResponse

def query(request):
    name = request.GET.get('name')
    age = request.GET.get('age')
    return JsonResponse({'name': name, 'age': age})

然后在 urls.py 文件中添加一个路由，并配置到项目 URL 中：

from django.urls import path
from . import views

urlpatterns = [
    path('hello/', views.hello, name='hello'),
    path('query/', views.query, name='query'), # 新增的路由
]

这样，当请求 '/api/query/?name=Tom&age=18' 地址时，就会访问到 api_app 中定义的 query 视图函数，并返回 {'name': 'Tom', 'age': '18'} 的 JSON 数据。

示例2：返回 POST 请求中的 JSON 数据

除了处理查询字符串参数，我们还可以处理 POST 请求中的 JSON 数据。

在 api_app 中创建一个新的视图函数：

import json
from django.http import JsonResponse

def post(request):
    data = json.loads(request.body)
    return JsonResponse(data)

这个函数中使用了 json.loads() 函数来将请求中的 JSON 数据转为 Python 对象，然后使用 JsonResponse 返回相应的 JSON 数据。

在 urls.py 文件中添加一个路由：

from django.urls import path
from . import views

urlpatterns = [
    path('hello/', views.hello, name='hello'),
    path('query/', views.query, name='query'),
    path('post/', views.post, name='post'), # 新增的路由
]

这样，当请求 '/api/post/' 地址并发送 JSON 数据时，就会访问到 api_app 中定义的 post 视图函数，并将请求中的 JSON 数据原样返回。

到这里，我们已经完成了使用 Django 开发 Python Web API 的全部步骤。具体使用中还有很多细节需要处理，但这个教程已经为大家提供了一个大体的框架和示例代码。