跳转到内容
搜索文档

参数

最后更新 查看 MarkdownAgent 设置

目的

参数是随端点传递的一个选项,用于接收特定的信息或值。

默认值、最小值和最大值

结构

必需组件

名称:格式化为代码片段的参数名称。

数据类型:指示参数是字符串(string)、整数(integer)、布尔值(boolean)、对象(object)还是数组(array)。

描述:描述参数的作用。对于字符串、整数、对象和数组,使用名词短语。对于布尔值,使用动词。以句号结束描述。

是否必需:指示参数是否是必需的。

可选组件

约束:列出参数的默认值、最小值或最大值。

写作指南

在撰写标题和描述时,请牢记我们的声音和语气。保持简明扼要,并记住我们的用户来自各种不同的技术水平。

有些参数描述更偏向事实陈述,例如 deviceName,以动词开头没有意义。其他参数则可能很适合以动词开头,这种差异是可以接受的。

尽量避免使用被动语态,力求用一句用户能够理解的简短句子来描述该参数的作用或用途。

以下是一些参数描述的示例,供参考:

deviceName:设备名称。

version:Cloudflare One 客户端版本。

per_page:设置请求结果的最大数量。

enabled:启用或禁用负载均衡器。

ASN:用于宣告前缀的自治系统号(Autonomous System Number,ASN)。

示例

名称actor.ip

数据类型string

描述:按特定 IP 地址或有效的 CIDR 范围过滤请求。

是否必需:非必需

:未列出默认值、最小值或最大值。

这篇文档对您有帮助吗?