预览与发布Customization

受众群体

使用受众群体筛选在 API 参考中显示的端点、架构和属性。

以 Markdown 格式查看
团队版和企业版功能

此功能仅适用于团队版和企业版套餐。要开始使用，请联系 support@buildwithfern.com。

受众群体是为不同消费者细分 API 的有用工具。受众群体的常见示例包括 public 和 beta。您可以在 OpenAPI 规范 和 Fern Definition 中配置受众群体。

将受众群体添加到 API 规范后，您可以通过在 docs.yml 导航中的 api 对象中添加 audience 属性来筛选到该受众群体。

docs.yml
1navigation:
2  - api: API Reference
3    audiences:
4      - public

这是 Schematic 在生产环境中的示例。

实例受众群体

API 参考受众群体与实例受众群体协同工作，后者控制哪些产品和版本出现在每个文档实例中。您可以同时使用这两个功能：

  • API 参考受众群体 - 控制哪些端点和架构出现在 API 参考中
  • 实例受众群体 - 控制哪些产品和版本出现在每个实例中

例如，您可能有一个仅显示公开端点的 public API 参考。为了确保此 API 参考仅出现在您的公开文档站点上，请使用 public 受众群体标记包含的产品或版本。