Django Ninja - 快速Django REST框架技术文档

Django Ninja - 快速Django REST框架技术文档

django-ninja 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs 项目地址: https://gitcode.com/gh_mirrors/dj/django-ninja

1. 安装指南

1.1 系统要求

• Python 3.6 或更高版本
• Django 2.2 或更高版本

1.2 安装步骤

使用 pip 安装 Django Ninja：

pip install django-ninja

2. 项目使用说明

2.1 创建API

在你的Django项目中，创建一个新的 api.py 文件：

from ninja import NinjaAPI

api = NinjaAPI()

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

2.2 配置URL

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

from django.urls import path
from .api import api

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

2.3 运行项目

启动Django开发服务器：

python manage.py runserver

访问 http://127.0.0.1:8000/api/add?a=1&b=2，你将看到返回的结果 {"result": 3}。

3. 项目API使用文档

3.1 基本API示例

Django Ninja 提供了一个简单的API示例，展示了如何处理GET请求并返回结果。

3.1.1 请求示例

• URL: /api/add
• 方法: GET
• 参数:
  • a: 整数
  • b: 整数

3.1.2 响应示例

{
  "result": 3
}

3.2 交互式API文档

Django Ninja 提供了交互式的API文档，可以通过以下URL访问：

• Swagger UI: http://127.0.0.1:8000/api/docs
• Redoc: http://127.0.0.1:8000/api/redoc

这些文档可以帮助你更好地理解和测试API。

4. 项目安装方式

4.1 使用pip安装

pip install django-ninja

4.2 从源码安装

你可以从GitHub克隆项目并手动安装：

git clone https://github.com/vitalik/django-ninja.git
cd django-ninja
pip install .

4.3 使用Docker

Django Ninja 也支持通过Docker进行安装和运行。你可以参考官方文档获取更多信息。

---

通过以上步骤，你可以快速上手并使用 Django Ninja 构建高效的 REST API。如果你有任何问题或反馈，欢迎通过 ppr.vitaly@gmail.com 联系项目维护者。

django-ninja 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs 项目地址: https://gitcode.com/gh_mirrors/dj/django-ninja