字段
使用 ParamField 和 ResponseField 组件记录 API 参数与响应字段，支持类型、默认值和嵌套对象。
字段可帮助你以清晰、一致的格式记录 API 参数和响应字段。
用法
<ParamField query="limit" type="number" default={10}>
Maximum number of results to return.
</ParamField>ParamField
使用 ParamField 记录 API 请求参数。使用 body、query、path 或 header 之一指定参数位置。
user_idstringrequired用户的唯一标识符。
limitnumberdefault: 10要返回的最大结果数。
Authorizationstringrequired用于身份验证的 Bearer 令牌。
<ParamField body="user_id" type="string" required>
The unique identifier for the user.
</ParamField>
<ParamField query="limit" type="number" default={10}>
Maximum number of results to return.
</ParamField>
<ParamField header="Authorization" type="string" required>
Bearer token for authentication.
</ParamField>路径参数
idstringrequiredURL 路径中的资源标识符。
<ParamField path="id" type="string" required>
Resource identifier in the URL path.
</ParamField>ParamField 属性
body 参数的参数名称。
查询字符串参数的参数名称。
URL 路径参数的参数名称。
header 参数的参数名称。
数据类型（string、number、boolean、array、object）。
显示“required”标记。
未提供值时使用的默认值。
ResponseField
使用 ResponseField 记录 API 响应属性。
idstringrequired资源的唯一标识符。
created_atstring资源创建时间的 ISO 8601 时间戳。
statusstringdefault: pending请求的当前状态。
<ResponseField name="id" type="string" required>
Unique identifier for the resource.
</ResponseField>
<ResponseField name="created_at" type="string">
ISO 8601 timestamp of when the resource was created.
</ResponseField>
<ResponseField name="status" type="string" default="pending">
Current status of the request.
</ResponseField>弃用字段
将字段标记为弃用，以表明它们将在未来版本中移除：
legacy_idnumberdeprecated请改用 id。此字段将在 v2 中移除。
<ResponseField name="legacy_id" type="number" deprecated>
Use `id` instead. This field will be removed in v2.
</ResponseField>标签
使用 pre 和 post 标签添加上下文：
optional
webhook_urlv2.1+string用于接收 Webhook 通知的 URL。
<ResponseField name="webhook_url" type="string" pre={["optional"]} post={["v2.1+"]}>
URL to receive webhook notifications.
</ResponseField>嵌套对象
结合 Expandable 记录嵌套对象属性：
userobject创建资源的用户。
<ResponseField name="user" type="object">
The user who created the resource.
<Expandable title="user properties">
<ResponseField name="id" type="string" required>
User's unique identifier.
</ResponseField>
<ResponseField name="email" type="string" required>
User's email address.
</ResponseField>
<ResponseField name="name" type="string">
User's display name.
</ResponseField>
</Expandable>
</ResponseField>ResponseField 属性
字段名称。
数据类型。
显示“required”标记。
以删除线标记字段为弃用。
默认值。
显示在字段名称前的标签。
显示在字段名称后的标签。