^ 请阅读 ^

学习快、编码快、运行快

Django Ninja - 快速 Django REST 框架

v1.0 新特性

在此处阅读更多详情 - https://django-ninja.dev/whatsnew_v1/

或观看此视频：

Django Ninja 是一个用于使用 Django 和 Python 3.6+ 类型提示构建 API 的 Web 框架。

主要特点：

• 简单：设计易用且直观。
• 执行速度快：得益于 Pydantic 和 异步支持，性能非常高。
• 编码快速：类型提示和自动文档让你只需专注于业务逻辑。
• 基于标准：基于 API 的开放标准：OpenAPI（以前称为 Swagger）和 JSON Schema。
• Django 友好：（显然）与 Django 核心和 ORM 有良好的集成。
• 生产就绪：多家公司在实际项目中使用（如果你使用 django-ninja 并愿意发布反馈，请发送邮件至 ppr.vitaly@gmail.com）。

文档：https://django-ninja.dev

安装

pip install django-ninja

使用

在你的 Django 项目中，在 urls.py 旁边创建新的 api.py 文件：

from ninja import NinjaAPI

api = NinjaAPI()


@api.get("/add")
def add(request, a: int, b: int):
    return {"result": a + b}

现在转到 urls.py 并添加以下内容：

...
from .api import api

urlpatterns = [
    path("admin/", admin.sites.urls),
    path("api/", api.urls),  # <---------- !
]

就是这样！

现在你已经创建了一个 API，它：

• 在 /api/add 接收 HTTP GET 请求
• 获取、验证并类型转换 GET 参数 a 和 b
• 将结果解码为 JSON
• 为定义的操作生成 OpenAPI 模式

交互式 API 文档

现在转到 http://127.0.0.1:8000/api/docs

你将看到自动生成的交互式 API 文档（由 Swagger UI 或 Redoc 提供）：

接下来做什么？

• 在这里阅读完整文档 - https://django-ninja.dev
• 要支持这个项目，请在 Github 上给它加星。
• 通过 Twitter 分享
• 如果你已经在使用 django-ninja，请将你的反馈发送到 ppr.vitaly@gmail.com