API 浏览器

Fern 的 API 浏览器允许用户在不离开文档的情况下对您的 API 进行身份验证请求。

使用示例自动填充

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

身份验证

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

一旦用户设置了身份验证凭据，他们的凭据将在整个探索会话中持续有效。

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

多环境

当在 OpenAPI 中配置了多个服务器 URL 时，用户可以通过 API 浏览器中的下拉菜单在环境之间切换（例如，生产环境和沙箱环境）。所选环境在用户在页面间导航时保持不变。

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

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

1
openapi: 3.0.0
2
servers:
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 演练场

对于支持 WebSocket 连接的 API，API 浏览器包含了 WebSocket 专用演练场。WebSocket 演练场还允许用户与 API 建立连接，并实时发送/接收消息。

控制 API 浏览器可用性

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