显示 HTTP 代码片段

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

如果你配置了 SDK 代码片段，默认会显示这些片段。否则，HTTP 代码片段会自动显示在你的 API 参考文档语言下拉菜单中。参见 Hume 的 API 参考文档作为示例。

配置

1
settings:
2
  http-snippets:
3
    - python
4
    - ruby

附加选项

设置默认代码片段语言

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

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

禁用语言下拉菜单

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

1
settings:
2
  http-snippets: false

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