预览与发布Code exploration

API 探索器

通过允许用户直接在 API 参考文档中对您的 API 进行真实调用，来减少”获得 200 响应的时间”。

以 Markdown 格式查看

Fern 的 API 探索器允许用户在不离开文档的情况下对您的 API 发起经过身份验证的请求。

使用示例自动填充

Fern 将自动使用 API 规范中设置的值填充端点的字段。

身份验证

API 探索器支持在您的 OpenAPI 规范或 generators.yml 中配置的所有身份验证方案，包括多种身份验证方案。当有多种方案可用时，API 探索器会自动在下拉菜单中显示它们，允许用户在发送请求之前选择并配置其首选的身份验证方法。

一旦用户设置了身份验证凭据，他们的凭据将在整个探索会话期间保持不变。

身份验证凭据仅使用 cookie 存储在客户端。不会收集或存储任何敏感的用户信息。

要为已登录用户自动填充 API 密钥，请参阅 API 密钥注入。

多环境

当在 OpenAPI 或 Fern Definition 中配置了多个服务器 URL 时，用户可以从 API 探索器的下拉菜单中在不同环境（例如，生产环境和沙盒环境）之间切换。所选环境在他们在页面之间导航时保持不变。

用户还可以双击服务器 URL 手动编辑它，允许快速测试自定义环境或端点。

这是配置了多个服务器名称的 Flagright 文档网站 示例。

1openapi: 3.0.0
2servers:
3  - url: https://sandbox.api.flagright.com
4    x-fern-server-name: Sandbox API server (eu-1)
5  - url: https://sandbox-asia-1.api.flagright.com
6    x-fern-server-name: Sandbox API server (asia-1)

WebSocket Playground

对于支持 WebSocket 连接的 API，API 探索器包含一个 WebSocket 特定的 Playground。WebSocket Playground 还允许用户与 API 建立连接，并实时发送/接收消息。

控制 API 探索器可用性

对于 OpenAPI 规范，API 探索器默认为所有端点启用。您可以使用 x-fern-explorer 扩展全局或按端点禁用它。这通常用于禁用破坏性操作、支付处理或仅限管理员端点的探索器。