API Explorer control (OpenAPI) | Fern Documentation

The API Explorer is enabled by default for all endpoints. Use x-fern-explorer to disable or it globally or to override it per operation. This is commonly used to disable the Explorer for destructive operations, payment processing, or admin-only endpoints.

Global

To disable the API Explorer for your entire API, add x-fern-explorer at the root level:

openapi.yml

openapi: 3.0.2
x-fern-explorer: false  # Disable Explorer for all endpoints
info:
  title: My API
  version: 1.0.0
paths:
  /payments:
    get:
      operationId: list_payments

Endpoint

To control the API Explorer for individual endpoints, use x-fern-explorer:

openapi.yml

paths:
  /payments:
    get:
      x-fern-explorer: true  # Enable Explorer for safe read operation
  /payments/charge:
    post:
      x-fern-explorer: false  # Disable to prevent accidental transactions

Combining global and endpoint-level settings

You can combine both extensions to set a default behavior globally and override it for specific endpoints:

openapi.yml

openapi: 3.0.2
x-fern-explorer: false  # Disable Explorer globally
info:
  title: My API
  version: 1.0.0
paths:
  /payments:
    get:
      operationId: list_payments
      x-fern-explorer: true  # Enable Explorer for safe read operation
  /payments/charge:
    post:
      operationId: charge_payment
      # Remains disabled (global setting applies)