For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
      • 概览
      • 折叠面板
      • 旁注
      • 按钮
      • 徽章
      • 下载
      • 提示框
      • 卡片
      • 代码块
      • 复制组件
      • 下载组件
      • 端点请求片段
      • 端点响应片段
      • 端点模式代码片段
      • Webhook 负载片段
      • 文件
      • 框架
      • 图标
      • If
      • 缩进
      • 参数字段
      • 提示词组件
      • Runnable endpoint
      • 模式组件
      • 步骤
      • 表格
      • 标签页
      • 工具提示
      • 版本
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 使用方法
  • 过滤字段
  • 属性
编写内容组件

Schema

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

可运行端点

下一个

步骤组件

<Schema> 组件可以在您的文档中的任何位置显示API参考中的类型定义。使用它来在API参考页面之外引用数据模型、请求对象或响应类型。

与 <EndpointSchemaSnippet> 类似,但接受任何类型名称,而不仅限于端点特定的模式。可以与 <SchemaSnippet> 配对使用,在字段分解旁边显示JSON表示。

该组件只能发现被端点引用的类型。仅被WebSocket或Webhook使用的类型将不可用。如果多个API具有相同的类型名称,组件会返回第一个匹配项。

使用方法

该组件与已在您的 docs.yml 中配置的API参考配合使用。此示例显示来自 docs-yml API的 AIChatConfig 类型:

modelenumOptional
Allowed values:
system-promptstringOptional
This is a system prompt that acts as context given to the LLM for AI chat.
Markdown
1<Schema type="AIChatConfig" />

过滤字段

使用 include 只显示特定字段,或使用 exclude 隐藏某些字段:

Markdown
1{/* 只显示这两个字段 */}
2<Schema type="AIChatConfig" include={["model", "provider"]} />
3
4{/* 显示除这些字段之外的所有字段 */}
5<Schema type="AIChatConfig" exclude={["model"]} />

属性

type
stringRequired

要显示的类型名称。组件将在您的API定义中的所有端点中搜索此类型。

api
string

要从中获取类型的API名称。如果未指定,将从包含该类型的第一个API中获取类型。

description
boolean

如果为 true,在模式字段上方包含类型定义的描述。这对于显示与类型关联的注释(如Protobuf消息注释)很有用。

include
string[]

要包含在渲染模式中的字段名称列表。当指定时,只会显示列出的字段。这在您想要明确控制显示哪些字段时很有用,避免了每当底层类型获得新字段时需要更新 exclude 列表的情况。

exclude
string[]

要从渲染模式中排除的字段名称列表。

excludeDeprecated
boolean

如果为 true,从渲染模式中隐藏已弃用的字段。

className
string

用于自定义样式的可选CSS类名。