AI 生成的示例 | Fern Documentation

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

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

配置

自定义生成示例的样式：

docs.yml

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

或完全禁用此功能：

docs.yml

1 ai-examples:
2   enabled: false

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

.gitignore

**/ai_examples_override.yml

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