FastAPI · 函数

文档描述

更新应用文档信息。

调用签名(应用, 标题: 'str' = None, 描述: 'str' = None, 版本: 'str' = '1.0.0', **选项)

文ZHONGWEN
PYTHON

Chinese example

中文代码示例

# 完整案例：按字段调用 文档描述
设 结果 = FastAPI.文档描述(
    应用="示例值",  # 必填；按函数业务含义传入 应用;首次使用建议先 打印(...
    标题=None,  # 可选；页面、窗口、报告或设计稿标题
    描述=None,  # 可选；字符串类型的 描述 参数,按函数业务含义传入对应...
    版本='1.0.0',  # 可选；字符串类型的 版本 参数,按函数业务含义传入对应...
    **{"字段": "值"},  # 可选；额外关键字参数，用字典形式展开传入
)
打印(结果)

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

Parameters

参数说明

5 个参数

参数类型 / 传入方式说明

应用可选 · 默认无

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

按函数业务含义传入应用;首次使用建议先打印(结果) 确认其作用。

常见错误：漏传会报 TypeError: missing required argument: '应用';检查调用是否漏了这行

标题可选 · 默认 None

str位置参数或字段名=值

页面、窗口、报告或设计稿标题。

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

描述可选 · 默认 None

str位置参数或字段名=值

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

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

版本可选 · 默认 '1.0.0'

str位置参数或字段名=值

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

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

选项可选 · 默认不传则为空

未声明可变关键字参数，用 **字典展开

额外关键字参数，用字典形式展开传入。

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

Playbook

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

# 完整案例：按字段调用 文档描述
设 结果 = FastAPI.文档描述(
    应用="示例值",  # 必填；按函数业务含义传入 应用;首次使用建议先 打印(...
    标题=None,  # 可选；页面、窗口、报告或设计稿标题
    描述=None,  # 可选；字符串类型的 描述 参数,按函数业务含义传入对应...
    版本='1.0.0',  # 可选；字符串类型的 版本 参数,按函数业务含义传入对应...
    **{"字段": "值"},  # 可选；额外关键字参数，用字典形式展开传入
)
打印(结果)

# 进阶组合:展示关键字段组合
设 结果 = FastAPI.文档描述(
    应用="示例值",  # 必填
    标题=None,  # 可选
    描述=None,  # 可选
)
打印(结果)

# 错误排查:覆盖 1 个必填参数

## 参数 1: 应用
# 错误:漏传会报 TypeError: missing required argument
# 设 结果 = FastAPI.文档描述()  # TypeError
# 修复:补上必填字段
设 结果 = FastAPI.文档描述(应用="示例值")
打印(结果)