taiyi
34e9be8912
- core: config、security、exceptions、responses、error_codes、db、main - models: base、business（17个模型类）、system（6个模型类）、__init__ - 每个函数和类均标注作用、返回值、被调用方 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
30 lines
915 B
Python
30 lines
915 B
Python
"""统一 API 响应格式构造工具。
|
|
|
|
所有 API 返回值通过 success_payload / success_response 包装，
|
|
保证前端收到的 JSON 结构始终为 { code, message, data }。
|
|
"""
|
|
|
|
from typing import Any
|
|
|
|
from backend.app.core.error_codes import ErrorCode
|
|
|
|
|
|
def success_response(data: Any = None, message: str = "success") -> dict[str, Any]:
|
|
"""构造标准成功响应字典。
|
|
|
|
被路由层直接使用，返回给 FastAPI 框架序列化。
|
|
|
|
Args:
|
|
data: 响应数据，可以是字典、列表等任意可序列化对象。
|
|
message: 响应提示信息，默认 "success"。
|
|
|
|
Returns:
|
|
dict: 包含 code、message、data 三个字段的响应字典。
|
|
"""
|
|
# 成功响应统一走这里，便于后续扩展 trace_id 等字段。
|
|
return {
|
|
"code": ErrorCode.SUCCESS,
|
|
"message": message,
|
|
"data": {} if data is None else data,
|
|
}
|