Fern Definition 中的受众 | Fern Documentation

团队版、专业版和企业版功能

此功能仅适用于团队版（文档）、专业版（SDK）和企业版计划。要开始使用，请联系 support@buildwithfern.com。

受众是为不同消费者分组 API 的有用工具。您可以配置 Fern Docs 发布特定于某个受众的文档。您也可以在 OpenAPI 规范中使用受众。

受众的常见示例包括：

内部消费者（例如，使用 API 的前端开发人员）
Beta 测试人员
客户

默认情况下，如果未指定受众，则所有消费者都可以访问。

配置

Fern Definition 具有为不同端点、类型和属性标记不同受众的一级概念。

要在 Fern Definition 中使用受众，请将其添加到 api.yml 中。

在下面的示例中，我们为 internal、beta 和 customer 群体创建了受众：

api.yml

1 name: api 
2 audiences: 
3   - internal 
4   - beta 
5   - customers

端点的受众

要为特定消费者标记端点，请添加包含相关群体的 audience。

在此示例中，sendEmail 端点仅对内部消费者可用：

user.yml

1 service:
2   base-path: /users
3   auth: true
4   endpoints:
5     sendEmail:
6       audiences:
7         - internal
8       path: /send-email
9       ...

类型的受众

类型也可以标记为不同的受众。

在此示例中，Email 类型对内部和 beta 消费者可用：

user.yml

1 Email: 
2   properties:
3     subject: string
4     body: optional<string>
5   audiences: 
6     - internal
7     - beta

属性的受众

类型的属性也可以标记为不同的受众。

在此示例中，to 属性仅对 beta 消费者可用：

user.yml

1 Email: 
2   properties:
3     subject: string
4     body: optional<string>
5     to: 
6       type: string
7       docs: The recipient of the email
8       audiences: 
9         - beta

SDK 的受众

在 generators.yml 中，您可以应用受众过滤器，以便只有某些端点传递给生成器。

以下示例配置 SDK 过滤 customers：

generators.yml

1 groups:
2   external:
3     audiences:
4       - customers
5     generators: 
6     ...

文档的受众

如果生成 Fern Docs，请更新您的 docs.yml 配置以包含您的受众。

以下示例展示了如何配置您的 docs.yml 为 customers 受众发布文档：

docs.yml

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