预览与发布Code exploration

显示 HTTP 代码片段

以 Markdown 格式查看

HTTP 代码片段使用常见的 HTTP 客户端（如 cURL、Python 的 requests 库和 TypeScript 的 fetch API）展示 API 请求示例。这些是通用代码示例，演示如何直接调用您的 API，而无需使用 SDK。

如果您配置了 SDK 代码片段，这些将默认显示。否则，HTTP 代码片段会自动显示在您的 API Reference 语言下拉菜单中。请参阅 Hume 的 API Reference 作为示例。

HTTP code snippet selector

代码片段自动包含身份验证标头、查询参数、请求体格式和内容类型标头。

配置

1

向您的 API 定义添加请求示例

HTTP 代码片段从您 API 定义中的请求示例生成：

2

选择要显示的语言

要在 HTTP 代码片段选择器中仅显示特定语言（除 cURL 外），请在 docs.yml 中列出它们。支持的值：csharp、curl、go、java、javascript、php、python、ruby、swift、typescript。

docs.yml
1settings:
2  http-snippets:
3    - python
4    - ruby

Fern 的开发工作由客户需求驱动。通过 提交 issue 请求支持此处未列出的语言。

其他选项

设置默认代码片段语言

在 docs.yml 的顶级缩进层级使用 default-language 键。此设置适用于 HTTP 代码片段和 SDK 代码片段。

docs.yml
1default-language: python
2
3navigation:
4  - api: API Reference

禁用语言下拉菜单

要禁用 HTTP 代码片段语言下拉菜单并仅显示 cURL 示例，请将 http-snippets 设置为 false：

docs.yml
1settings:
2  http-snippets: false

这会从选择器中移除除 cURL 外的所有 HTTP 代码片段语言。cURL 始终显示，无法通过 docs.yml 配置移除。要隐藏 cURL，请 使用自定义 CSS。