mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
9ead99bb2b
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
---
|
|
title: "响应字段"
|
|
description: "使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。"
|
|
keywords: ["API 输出", "返回值", "响应结构"]
|
|
---
|
|
|
|
使用 `<ResponseField>` 组件来定义 API 的返回值。在需要列出某些对象的类型时，许多文档页面也会使用 `<ResponseField>`。
|
|
|
|
<ResponseField name="response" type="string" required>
|
|
响应字段示例
|
|
</ResponseField>
|
|
|
|
```mdx
|
|
<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
|
|
<ResponseField name="response" type="string" required>
|
|
响应字段示例
|
|
</ResponseField>
|
|
```
|
|
|
|
</RequestExample> |