FastAPI · 函数

统一响应

生成统一响应格式。

调用签名(数据=None, 消息: 'str' = '成功', 状态码: 'int' = 200, 错误: 'str' = None)

统ZHONGWEN
PYTHON

Chinese example

中文代码示例

# 完整案例：按字段调用 统一响应
设 结果 = FastAPI.统一响应(
    数据=None,  # 可选；要处理的原始数据，可以是列表、字典、DataFr...
    消息='成功',  # 可选；要发布到 MQTT 主题的消息内容
    状态码=200,  # 可选；整数类型的 状态码 参数,按函数业务含义传入对应...
    错误=None,  # 可选；字符串类型的 错误 参数,按函数业务含义传入对应...
)
打印(结果)

可直接放进 .cs / .中py 文件运行。转换器会把中文代码交给真实 Python 解释器。

Parameters

参数说明

4 个参数

参数类型 / 传入方式说明

数据可选 · 默认 None

未声明位置参数或字段名=值

要处理的原始数据，可以是列表、字典、DataFrame、数组等。

常见错误：类型不匹配会报 TypeError;按字段类型列传值,首次使用建议先打印(结果) 确认结构

消息可选 · 默认 '成功'

str位置参数或字段名=值

要发布到 MQTT 主题的消息内容。

常见错误：传非字符串会报 TypeError;按字符串类型传值

状态码可选 · 默认 200

int位置参数或字段名=值

整数类型的状态码参数,按函数业务含义传入对应数值。

常见错误：传非整数会报 TypeError;按整数类型传值

错误可选 · 默认 None

str位置参数或字段名=值

字符串类型的错误参数,按函数业务含义传入对应文本。

常见错误：传非字符串会报 TypeError;按字符串类型传值

Playbook

基础用法 · 进阶组合 · 错误排查

# 完整案例：按字段调用 统一响应
设 结果 = FastAPI.统一响应(
    数据=None,  # 可选；要处理的原始数据，可以是列表、字典、DataFr...
    消息='成功',  # 可选；要发布到 MQTT 主题的消息内容
    状态码=200,  # 可选；整数类型的 状态码 参数,按函数业务含义传入对应...
    错误=None,  # 可选；字符串类型的 错误 参数,按函数业务含义传入对应...
)
打印(结果)

# 进阶组合:展示关键字段组合
设 结果 = FastAPI.统一响应(
    数据=None,  # 可选
    消息='成功',  # 可选
    状态码=200,  # 可选
)
打印(结果)

# 错误排查:类型不匹配
# 错误:传错类型
# 设 结果 = FastAPI.统一响应(数据=None)  # TypeError
# 修复:按字段类型 未声明 传值
设 结果 = FastAPI.统一响应(数据=None)
打印(结果)