Django Ninja 教程：请求参数解析实战指南

Django Ninja 教程：请求参数解析实战指南

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

前言

在现代Web开发中，处理客户端请求参数是API开发的基础环节。本文将深入讲解如何使用Django Ninja框架高效地解析各类请求参数，包括查询字符串、路径参数和请求体数据。

查询字符串参数处理

基础用法

Django Ninja处理查询字符串参数非常简单，只需在视图函数中声明对应的参数即可：

@api.get("/hello")
def hello(request, name):
    return f"Hello {name}"

当访问/api/hello?name=John时，将返回：

"Hello John"

参数默认值设置

在实际开发中，我们经常需要为可选参数设置默认值：

@api.get("/hello")
def hello(request, name="world"):
    return f"Hello {name}"

这样当客户端不提供name参数时，将使用默认值"world"响应。

参数类型系统

类型注解的重要性

Django Ninja充分利用Python的类型提示系统，可以自动进行参数类型转换和验证：

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

访问/api/math?a=2&b=3将得到：

{
  "add": 5,
  "multiply": 6
}

最佳实践建议：

1. 始终为参数添加类型注解
2. 基本类型优先使用Python原生类型（int, str, float等）
3. 复杂类型可使用typing模块中的类型

路径参数处理

RESTful风格参数

路径参数是构建RESTful API的常见方式，Django Ninja采用Python格式字符串语法：

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

访问/api/math/2and3将获得与查询字符串相同的效果。

路径参数特点：

• 必须提供，没有默认值概念
• 在URL中位置固定
• 适合标识资源的关键属性

请求体数据处理

Schema模式定义

对于POST等包含请求体的方法，我们需要定义Schema来处理复杂数据：

from ninja import NinjaAPI, Schema

api = NinjaAPI()

class HelloSchema(Schema):
    name: str = "world"

@api.post("/hello")
def hello(request, data: HelloSchema):
    return f"Hello {data.name}"

Schema的优势：

1. 自动数据验证
2. 支持嵌套数据结构
3. 自动生成API文档
4. 支持默认值和可选字段

交互式文档

Django Ninja自动集成了Swagger UI，位于/api/docs路径下。通过这个界面可以：

1. 查看所有API端点
2. 测试各个接口
3. 查看请求/响应模型
4. 获取curl命令示例

总结

本文详细介绍了Django Ninja框架中处理各类请求参数的方法。从简单的查询字符串到复杂的请求体数据，Django Ninja都提供了简洁而强大的解决方案。合理运用这些特性，可以构建出既健壮又易用的API接口。

关键要点回顾：

• 查询字符串适合可选参数
• 路径参数适合资源标识
• 请求体适合复杂数据结构
• 类型注解是良好实践
• 交互式文档提升开发效率

在下一章节中，我们将深入探讨Django Ninja的响应处理机制，学习如何构建更加规范的API响应。

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