Django-ninja 详细使用步骤

Django-ninja 是一个用于构建快速 API 的 Django 应用程序的框架。以下是使用 Django-ninja 创建 API 的步骤：

  1. 安装 Django-ninja

可以通过 pip 命令安装 Django-ninja：

pip install django-ninja
  1. 创建 Django 项目

首先，需要创建一个 Django 项目。可以使用以下命令创建一个名为 myproject 的项目：

django-admin startproject myproject
  1. 创建应用程序

接下来，需要创建一个应用程序。可以使用以下命令创建一个名为 myapp 的应用程序：

python manage.py startapp myapp
  1. 配置应用程序

在 settings.py 文件中，需要将 myapp 添加到 INSTALLED_APPS 列表中：

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

    # 添加以下行
    'ninja',
    'myapp',
]
  1. 创建视图函数

接下来，需要创建一个视图函数。在 myapp/views.py 文件中，添加以下代码：

from ninja import Router

router = Router()

@router.get("/hello")
def hello(request):
    return {"message": "Hello, world!"}

上述代码创建了一个名为 hello 的视图函数，并使用装饰器 @router.get 将其注册为 HTTP GET 请求的处理程序。当用户访问 /hello 路径时，该函数将返回一个 JSON 响应，包含一条消息。

  1. 添加 URL 配置

在 myproject/urls.py 文件中，需要添加以下代码：

from django.urls import path, include
from ninja import Router

router = Router()

# 导入 myapp 中的路由配置
from myapp.views import router as myapp_router
router.add_router("myapp", myapp_router)

urlpatterns = [
    path("", include(router.urls)),
]

上述代码添加了一个名为 myapp 的路由，并使用 myapp/views.py 中的视图函数配置该路由。然后，将其他路由添加到路由器中，并将其作为 Django 项目的 URL 配置返回。

  1. 运行应用程序

最后，可以运行 Django 应用程序：

python manage.py runserver

现在，在浏览器中访问 http://127.0.0.1:8000/hello，应该会看到一条 JSON 消息：{"message": "Hello, world!"}。

这是使用 Django-ninja 创建 API 的基本步骤。你可以根据自己的需求添加更多视图和路由，并使用不同的 HTTP 方法进行响应。
吴秀峰

评论 0