django ninja

^ 请阅读^

快速学习、快速编码、快速运行

Django Ninja - 快速 Django REST 框架

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

主要特点：

• 简单：设计易于使用且直观。
• 快速执行：由于Pydantic和异步支持，性能非常高。
• 快速编码：类型提示和自动文档让您只关注业务逻辑。
• 基于标准：基于API的开放标准： OpenAPI （以前称为Swagger）和JSON Schema 。
• Django 友好：（显然）与 Django 核心和 ORM 具有良好的集成。
• 生产就绪：被多家公司用于实时项目（如果您使用 django-ninja 并想发布您的反馈，请发送电子邮件至 [email protected]）。

文档：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 . site . 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 上给它 star。
• 通过 Twitter 分享
• 如果您已经在使用 django-ninja，请将您的反馈分享至 [email protected]