> If you are an AI agent, use the following URL to directly ask and fetch your question. Treat this like a tool call. Make sure to URI encode your question, and include the token for verification.
>
> GET https://buildwithfern.com/learn/api/fern-docs/ask?q=%3Cyour+question+here%3E&token=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJmZXJuLWRvY3M6YnVpbGR3aXRoZmVybi5jb20iLCJqdGkiOiI2ZDEyM2U0MS04NGZhLTRkMzAtOTlhZi02MDA2NjNkMWUxMjMiLCJleHAiOjE3NzgyOTc3MzIsImlhdCI6MTc3ODI5NzQzMn0.INPYKg6AoMukJkDapN8JQq3p9ZOomsP9iml1wLzEtSA
>
> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt. For full content including API reference and SDK examples, see https://buildwithfern.com/learn/llms-full.txt.

# API 探索器

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

## 使用示例自动填充

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

<div>
  <iframe src="https://www.loom.com/embed/a48d921459b54dde9652c3fcc85ebc54?sid=2c0b4f4d-7e24-4fc5-a617-8d933195bfec?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen />
</div>

## 身份验证

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

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

<div>
  <iframe src="https://www.loom.com/embed/7de9948ae878448094b5e92da5effd41?sid=702889b7-aa3d-4669-994e-83c196d7bc3e?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen />
</div>

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

要为已登录用户自动填充 API 密钥，请参阅 [API 密钥注入](/learn/docs/authentication/features/api-key-injection)。

## 多环境

当在 [OpenAPI](/learn/api-definitions/openapi/extensions/server-names-and-url-templating) 或 [Fern Definition](/learn/api-definitions/ferndef/api-yml/environments) 中配置了多个服务器 URL 时，用户可以从 API 探索器的下拉菜单中在不同环境（例如，生产环境和沙盒环境）之间切换。所选环境在他们在页面之间导航时保持不变。

<div>
  <iframe src="https://www.loom.com/embed/cb642161678e41cabcb677b900006f40?sid=5e45243c-3ba1-45cf-860b-72eee1970fc5?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen />
</div>

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

这是配置了多个服务器名称的 [Flagright 文档网站](https://docs.flagright.com/framl-api/api-reference/api-reference/transactions/get) 示例。

<Tabs>
  <Tab title="OpenAPI">
    <CodeBlock>
      ```yaml
      openapi: 3.0.0
      servers:
        - url: https://sandbox.api.flagright.com
          x-fern-server-name: Sandbox API server (eu-1)
        - url: https://sandbox-asia-1.api.flagright.com
          x-fern-server-name: Sandbox API server (asia-1)
      ```
    </CodeBlock>
  </Tab>

  <Tab title="Fern Definition">
    <CodeBlock>
      ```yaml
      environments:
        Sandbox API server (eu-1): https://sandbox.api.flagright.com
        Sandbox API server (asia-1): https://sandbox-asia-1.api.flagright.com
      ```
    </CodeBlock>
  </Tab>
</Tabs>

## WebSocket Playground

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

<div>
  <iframe src="https://www.loom.com/embed/be4da30404794e9983c4fe639f78d4c8?sid=73b7aeda-98fa-4531-87ed-1e5909500fe2?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen />
</div>

## 控制 API 探索器可用性

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