> ## Documentation Index
> Fetch the complete documentation index at: https://adminroletesting-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 响应字段

> 使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。

使用 `<ResponseField>` 组件来定义 API 的返回值。在需要列出某些对象的类型时，许多文档页面也会使用 `<ResponseField>`。

<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>

```mdx theme={null}
<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>
```

<div id="props">
  ## 属性
</div>

<ResponseField name="name" type="string" required>
  响应值的名称。
</ResponseField>

<ResponseField name="type" type="string" required>
  响应值的预期类型——可以是任意字符串。
</ResponseField>

<ResponseField name="default" type="string">
  默认值。
</ResponseField>

<ResponseField name="required" type="boolean">
  在字段名旁显示“required”。
</ResponseField>

<ResponseField name="deprecated" type="boolean">
  指示你是否已废弃该字段。
</ResponseField>

<ResponseField name="pre" type="string[]">
  出现在字段名之前的标签
</ResponseField>

<ResponseField name="post" type="string[]">
  出现在字段名之后的标签
</ResponseField>

<RequestExample>
  ```mdx Response Field Example theme={null}
  <ResponseField name="response" type="string" required>
    响应字段示例
  </ResponseField>
  ```
</RequestExample>