可运行端点

<RunnableEndpoint> 组件让用户直接从您的文档中向您的 API 发出真实的 HTTP 请求。它会自动从您的 API 规范中检测端点定义，为标头、路径参数、查询参数和请求体渲染请求构建器，并内联显示响应状态、标头、正文和时间。表单输入在页面重新加载时会保存在本地存储中。

用法

Markdown

1 <RunnableEndpoint endpoint="POST /chat/{domain}" />

使用 collapsed 来渲染组件，表单部分处于隐藏状态。用户可以通过单击组件来展开它。

Markdown

1 <RunnableEndpoint endpoint="POST /chat/{domain}" collapsed />

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 类名。