受众群体

使用受众群体来过滤在 API 参考文档中显示的端点、模式和属性。

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

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

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

docs.yml

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

实例受众群体

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

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