mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
fbdd913d8e
* Add translation tracker for stale translations audit Generated-By: mintlify-agent * translations: add missing pages and update content for es, fr, zh Phase 1: Add translations for 4 new API analytics pages (feedback-by-page, searches, views, visitors) in es, fr, and zh. Phase 2: Update 3 pages with content changes: - agent/workflows: add "Disable a workflow" subsection - ai/skillmd: add 24-hour generation note - editor/publish: add AI PR title tip, reformat publishing workflows, promote "Publish your changes" heading from h3 to h2 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * update descriptions * translations * translations * translations * Delete TRANSLATION_TRACKER.md * translations * a * a * translations * translations * translations * translations * translations * translations * translations * translations * Update use-cases.mdx * translations * translations * Update ai-native.mdx * Update accordions.mdx * Update accordions.mdx * Update accordions.mdx * translations * translations * Update fonts.mdx * translations * translations: update SEO descriptions for es, fr, zh (150 pages) Update the description: frontmatter field across 150 pages × 3 languages to match the current English descriptions updated on 2026-03-31. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
---
|
|
title: "响应字段"
|
|
description: "使用类型注解、描述和必填/可选标记编写 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> |