October 17, 2025

HTTP 代码片段现在默认启用

HTTP 代码片段现在默认为所有文档站点启用,让开发者更容易直接在您的 API 参考中查看 cURL、Python、Ruby 和其他 HTTP 客户端示例。以前,此功能需要内部配置才能激活。

您现在可以直接在 docs.yml 文件中控制 HTTP 代码片段:

docs.yml
1# 关闭 HTTP 代码片段
2settings:
3 http-snippets: false
4
5# 或仅指定特定语言
6settings:
7 http-snippets:
8 - python
9 - ruby
阅读文档

引入可运行端点

通过我们新的交互式组件直接从您的文档测试 API 端点。可运行端点允许您的用户在不离开文档的情况下向您的 API 发送真实的 HTTP 请求,让开发者更容易探索和理解您的 API。

可运行端点组件

将该组件嵌入到您的 MDX 文档中的任何地方,创建一个交互式请求构建器,包含标头、路径参数、查询参数和请求体的表单输入。用户可以执行请求并查看实时响应,包含状态码和语法高亮。

主要功能包括:

  • 交互式表单构建器,根据您的端点定义自动生成输入
  • 多示例支持,当您有多个预配置场景时提供下拉选择器
  • 环境选择器,用于针对生产、测试或开发环境进行测试
  • 表单持久化,在本地存储中保存用户输入,跨会话使用
  • 直接导航,通过”在 API 参考中打开”按钮跳转到完整的 API 参考
阅读文档