---
title: 字段
description: 使用 ParamField 和 ResponseField 组件记录 API 参数与响应字段，支持类型、默认值和嵌套对象。
---
> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.
字段可帮助你以清晰、一致的格式记录 API 参数和响应字段。
## 用法
```mdx
Maximum number of results to return.
```
## ParamField
使用 `ParamField` 记录 API 请求参数。使用 `body`、`query`、`path` 或 `header` 之一指定参数位置。
用户的唯一标识符。
要返回的最大结果数。
用于身份验证的 Bearer 令牌。
```mdx
The unique identifier for the user.
Maximum number of results to return.
Bearer token for authentication.
```
### 路径参数
URL 路径中的资源标识符。
```mdx
Resource identifier in the URL path.
```
### ParamField 属性
body 参数的参数名称。
查询字符串参数的参数名称。
URL 路径参数的参数名称。
header 参数的参数名称。
数据类型（string、number、boolean、array、object）。
显示“required”标记。
未提供值时使用的默认值。
## ResponseField
使用 `ResponseField` 记录 API 响应属性。
资源的唯一标识符。
资源创建时间的 ISO 8601 时间戳。
请求的当前状态。
```mdx
Unique identifier for the resource.
ISO 8601 timestamp of when the resource was created.
Current status of the request.
```
### 弃用字段
将字段标记为弃用，以表明它们将在未来版本中移除：
请改用 `id`。此字段将在 v2 中移除。
```mdx
Use `id` instead. This field will be removed in v2.
```
### 标签
使用 `pre` 和 `post` 标签添加上下文：
用于接收 Webhook 通知的 URL。
```mdx
URL to receive webhook notifications.
```
### 嵌套对象
结合 `Expandable` 记录嵌套对象属性：
创建资源的用户。
用户的唯一标识符。
用户的电子邮件地址。
用户的显示名称。
```mdx
The user who created the resource.
User's unique identifier.
User's email address.
User's display name.
```
### ResponseField 属性
字段名称。
数据类型。
显示“required”标记。
以删除线标记字段为弃用。
默认值。
显示在字段名称前的标签。
显示在字段名称后的标签。
## 接下来做什么？
浏览所有可用组件
了解如何在 MDX 中使用组件