For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 概览
    • 什么是 API 定义?
    • 项目结构
      • 概览
      • 覆盖层(Overlays)
      • 覆盖(Overrides)
      • 身份验证
      • 服务器
      • 同步您的规范
        • 概览
        • API 版本
        • 受众
        • 可用性
        • 基础路径
        • 默认值
        • 枚举描述、名称和可用性
        • API Explorer 控制
        • 全局请求头
        • 忽略元素
        • SDK 变量
        • SDK 方法名称
        • 参数名称
        • 属性名称
        • 幂等性
        • 分页
        • 重试行为
        • Schema 名称
        • 服务器名称和 URL 模板化
        • 模式名称
        • 服务器名称和 URL 模板化
      • OpenAPI generators.yml 参考
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • Available extensions
  • FastAPI
OpenAPI扩展

Extensions overview

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

服务器发送事件和流式 API

下一个

API 版本

Fern supports a variety of OpenAPI extensions that enhance your API specification and generate higher-quality SDKs and CLIs.

You can apply these extensions in two ways: by overlaying them in a separate file or by embedding them directly in your OpenAPI specification. See Overlays for more information.

Available extensions

The table below shows all available extensions and links to detailed documentation for each one.

ExtensionDescription
x-fern-versionConfigure API version schemes and headers
x-fern-audiencesFilter endpoints, schemas, and properties by audience
x-fern-basicCustomize basic authentication parameter names and environment variables
x-fern-bearerCustomize bearer authentication parameter names and environment variables
x-fern-availabilityMark availability status (beta, generally-available, deprecated)
x-fern-base-pathSet base path prepended to all endpoints
x-fern-defaultSet client-side default values for path, header, and query parameters
x-displayNameSpecify how tag names display in your API Reference
x-fern-enumAdd descriptions, custom names, and deprecation status to enum values
x-fern-examplesAssociate request and response examples
x-fern-explorerControl API Explorer (playground) availability globally or per endpoint
x-fern-global-headersConfigure headers used across all endpoints
x-fern-headerCustomize API key header authentication parameter names and environment variables
x-fern-idempotentMark an endpoint as idempotent
x-fern-idempotency-headersConfigure idempotency headers for safe request retries
x-fern-ignoreSkip reading specific endpoints or schemas
x-fern-paginationConfigure auto-pagination for list endpoints
x-fern-sdk-method-nameCustomize SDK method names
x-fern-sdk-group-nameOrganize methods into SDK groups
x-fern-sdk-variablesSet common path parameters across all requests
x-fern-parameter-nameCustomize parameter variable names
x-fern-property-nameCustomize object property variable names
x-fern-retriesConfigure retry behavior for endpoints
x-fern-streamingConfigure streaming endpoints (JSON or SSE)
x-fern-type-nameOverride auto-generated names for inline schemas
x-fern-default-urlProvide a static fallback URL for templated server URLs
x-fern-server-nameName your servers and configure URL templating
x-fern-webhookDefine webhooks in OpenAPI 3.0 specifications
x-fern-webhook-signatureConfigure webhook signature verification for HMAC or asymmetric validation
Request a new extension

If there’s an extension you want that doesn’t already exist, file an issue to start a discussion about it.

FastAPI

FastAPI allows you to add extensions directly in your route decorators and models. See our FastAPI integration guide for detailed examples.