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 中的富媒体
    • 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
预约演示登录免费开始
在本页
  • 配置
AI 功能

AI 生成的示例

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

Fern Writer

下一个

Markdown 访问

Fern 使用 AI 为您的 API Reference 文档自动生成真实的请求和响应示例。此功能默认为所有 API Reference 页面启用。您将获得反映端点属性和描述的可信数据,而不是像 username: "string" 这样的占位符值。示例会随着您的规范变化自动更新。

AI 示例与在 x-fern-examples 中定义的手动示例一起工作,手动示例具有优先级。

之前
之后
带有占位符字符串值的 API Reference

配置

自定义生成示例的样式:

docs.yml
1ai-examples:
2 style: "Use names and emails that are inspired by plants."

或完全禁用此功能:

docs.yml
1ai-examples:
2 enabled: false

AI 生成的示例将写入 ai_examples_override.yml。编辑此文件以自定义特定示例。要在每次构建时重新生成示例,请将该文件添加到 .gitignore:

.gitignore
**/ai_examples_override.yml

要使 AI 生成的示例可移植到非 Fern OpenAPI 工具,请使用 fern api enrich 将它们合并到原生 OpenAPI 示例字段中。