编写内容组件

参数字段

以 Markdown 格式查看

ParamField 组件记录 API 参数和属性，为类型、要求、默认值和描述提供一致的格式。

用法

username
stringRequired

用户的显示名称

limit
numberDefaults to 50

要返回的最大项目数

Markdown
1<ParamField path="username" type="string" required={true}>
2  用户的显示名称
3</ParamField>
4
5<ParamField path="limit" type="number" default="50">
6  要返回的最大项目数
7</ParamField>

变体

已弃用的参数

api_key
stringDeprecated

请改用 OAuth 身份验证

Markdown
1<ParamField path="api_key" type="string" deprecated={true}>
2  请改用 OAuth 身份验证
3</ParamField>

联合类型

status
'active' | 'inactive' | 'pending'Defaults to active

用户账户的当前状态

Markdown
1<ParamField path="status" type="'active' | 'inactive' | 'pending'" default="active">
2  用户账户的当前状态
3</ParamField>

属性

path
string

参数的名称（例如，“username”、“limit”）

type
stringRequired

参数的数据类型（例如，“string”、“number”、“boolean”）

required
boolean

指示参数是否为必需。当为 true 时显示”必需”标签。

default
string

参数的默认值（如果有）

deprecated
boolean

将参数标记为已弃用。

toc
boolean

是否在目录中包含该参数。默认为 false。