介绍Django Ninja框架

news2024/10/5 17:19:54

文章目录

- 安装
- 快速开始
- 特性详解
- - 自动文档生成
  - 定义请求和响应模型
  - 异步支持
  - 中间件支持
  - 测试客户端
- 结论

Django Ninja是一个基于Python的快速API开发框架，它结合了Django和FastAPI的优点，提供了简单易用的方式来构建高性能的Web API。
在这里插入图片描述

安装

使用以下命令安装Django Ninja：

pip install django-ninja

快速开始

首先，在你的Django项目中创建一个新的API应用：

python manage.py startapp api

然后，定义一个简单的API视图：

# api/views.py
from ninja import NinjaAPI

api = NinjaAPI()


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

接下来，将这个视图注册到你的项目中：

# api/urls.py
from django.urls import path
from .views import api

urlpatterns = [
    path("api/", api.urls),
]

最后，在你的项目的urls.py中包含这个新的API应用的URL配置：

# project/urls.py
from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('api.urls')),
]

现在，你可以通过访问http://yourdomain/api/hello来查看API的响应了。

特性详解

自动文档生成

Django Ninja内置了自动生成API文档的功能，可以通过访问/api/docs来查看所有可用端点、请求和响应的结构以及参数说明。这样的自动文档生成大大简化了API的使用和测试过程，提高了开发效率。

定义请求和响应模型

借助Pydantic模型，Django Ninja允许开发者定义请求和响应的数据结构，从而实现数据的验证和转换。通过定义模型，可以确保输入数据的正确性，并且方便地进行数据序列化和反序列化操作。

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str

@api.post("/user")
def create_user(request, user: User):
    return user

异步支持

Django Ninja支持异步处理请求和返回响应，这意味着可以利用Python的异步特性来提高性能和并发处理能力。通过使用async def定义视图函数和在需要的地方使用await关键字，可以实现异步处理逻辑。

@api.get("/async")
async def async_view(request):
    await asyncio.sleep(1)
    return {"message": "Async Response"}

中间件支持

与Django一样，Django Ninja也支持中间件机制，允许开发者在请求处理的不同阶段添加额外的逻辑。可以通过编写自定义中间件函数并将其应用到API应用中，实现诸如身份验证、日志记录等功能。

def custom_middleware(request, call_next):
    # 在请求处理前执行一些操作
    response = call_next(request)
    # 在请求处理后执行一些操作
    return response

api.add_middleware(custom_middleware)

测试客户端

Django Ninja提供了方便的测试客户端，可以用于编写单元测试和集成测试。测试客户端可以模拟HTTP请求并获取响应，用于验证API端点的行为是否符合预期。这样可以保证API的稳定性和正确性。

from ninja.testing import TestClient

client = TestClient(api)

def test_hello():
    response = client.get("/hello")
    assert response.status_code == 200
    assert response.json()["message"] == "Hello, World!"