Fern 定义中的受众
Fern 定义中的受众
在 Fern 定义中使用受众来为不同的 API 消费者群体进行分段。
Fern 定义中的受众
在 Fern 定义中使用受众来为不同的 API 消费者群体进行分段。
此功能仅适用于团队版和企业版计划。要开始使用，请联系 support@buildwithfern.com。
受众是一个用于为不同消费者分段 API 的有用工具。您可以配置 Fern Docs 来发布特定于某个受众的文档。您也可以在 OpenAPI 规范中使用受众。
受众的常见示例包括：
默认情况下，如果没有指定受众，所有消费者都可以访问。
Fern 定义具有为不同端点、类型和属性标记不同受众的一级概念。
要在 Fern 定义中使用受众，请将其添加到 api.yml 中。
在下面的示例中，我们为 internal、beta 和 customer 群体创建了受众：
要为特定消费者标记端点，请添加包含相关群体的 audience。
在此示例中，sendEmail 端点仅对内部消费者可用：
类型也可以为不同受众进行标记。
在此示例中，Email 类型对内部和 beta 消费者可用：
类型的属性也可以为不同受众进行标记。
在此示例中，to 属性仅对 beta 消费者可用：
在 generators.yml 中，您可以应用受众过滤器，以便只有某些端点传递给生成器。
以下示例配置 SDK 过滤 customers：
如果生成 Fern Docs，请更新您的 docs.yml 配置以包含您的受众。
以下示例显示如何配置 docs.yml 来为 customers 受众发布文档：