API Explorer 控制 (OpenAPI) | Fern Documentation

API Explorer 默认为所有端点启用。使用 x-fern-explorer 全局禁用或按操作覆盖。这通常用于对破坏性操作、支付处理或仅限管理员的端点禁用 Explorer。

全局

要为整个 API 禁用 API Explorer，请在根级别添加 x-fern-explorer：

openapi.yml

1 openapi: 3.0.2
2 x-fern-explorer: false  # 为所有端点禁用 Explorer
3 info:
4   title: My API
5   version: 1.0.0
6 paths:
7   /payments:
8     get:
9       operationId: list_payments

端点

要控制各个端点的 API Explorer，请使用 x-fern-explorer：

openapi.yml

1 paths:
2   /payments:
3     get:
4       x-fern-explorer: true  # 为安全的读取操作启用 Explorer
5   /payments/charge:
6     post:
7       x-fern-explorer: false  # 禁用以防止意外交易

结合全局和端点级别设置

您可以结合使用两种扩展来全局设置默认行为并为特定端点覆盖：

openapi.yml

1 openapi: 3.0.2
2 x-fern-explorer: false  # 全局禁用 Explorer
3 info:
4   title: My API
5   version: 1.0.0
6 paths:
7   /payments:
8     get:
9       operationId: list_payments
10       x-fern-explorer: true  # 为安全的读取操作启用 Explorer
11   /payments/charge:
12     post:
13       operationId: charge_payment
14       # 保持禁用（应用全局设置）