编写内容组件

可运行端点

以 Markdown 格式查看

<RunnableEndpoint> 组件允许用户直接在 API 参考文档中对您的 API 发起真实的 HTTP 请求。它会自动从您的 API 规范中检测端点定义，并提供一个请求构建器，支持输入标头、路径参数、查询参数和请求体。

使用方法

Runnable Endpoint component example
Markdown
1<RunnableEndpoint endpoint="GET /api/users/{id}" />

功能特性

该组件支持：

  • 多个示例 – 当您的端点配置了多个预设示例时，组件会在标头显示一个下拉选择器，用户可以在不同示例之间切换
  • 多环境支持 – 如果您的 API 定义了多个环境（生产、预发布、开发），组件会自动显示环境选择器，用户可以针对不同的基础 URL 进行测试
  • API 参考集成 – 每个 <RunnableEndpoint> 都包含一个按钮，可以链接到该端点的完整 API 参考文档
  • 实时响应预览 – 用户发送请求后可以立即查看响应状态、标头、响应体和响应时间
  • 表单持久化 – 表单输入会自动保存在浏览器的本地存储中，即使在页面间导航或刷新浏览器时，用户的测试数据也会被保留

属性

endpoint
string

“METHOD /path” 格式的端点定位符。例如："POST /api/users" 或 "GET /api/users/{id}"。如果您的 API 使用了命名空间，请使用命名空间和 :: 作为前缀（例如："payments::POST /api/users"）。

example
string

使用指定名称的示例预填充表单。如果未指定，默认使用第一个示例。

defaultEnvironment
string

设置端点的默认环境。该值必须对应于您的 API 规范中定义的服务器 URL 的 x-fern-server-name。如果未指定，默认使用第一个环境。

readonly
list of strings

通过隐藏下拉选择器来锁定的字段。接受 "environment" 来锁定服务器 URL 并防止用户切换环境。当设置为 readonly={["environment"]} 时，环境选择器会被隐藏，端点使用 defaultEnvironment 指定的环境（如果未指定则使用第一个环境）。

collapsed
booleanDefaults to false

控制组件是否默认以折叠状态渲染，隐藏表单部分。设置为 collapsed={true} 或使用简写 collapsed。用户可以通过点击组件来展开它。

className
string

用于自定义组件容器样式的 CSS 类名。