Audiences are a useful tool for segmenting your API for different consumers. Common audiences include:
- Internal consumers (e.g., frontend developers who use the API)
- Beta testers
Fern has a first-class concept for marking different endpoints, types, and properties for different audiences.
To prevent typos, you must specify all your audiences in
generators.yml, you can apply audience filters so that only certain
endpoints are passed to the generators:
By default, if no audiences are specified, then all endpoints, types, and properties are passed to the generators.
Audiences for Endpoints
In this example, the
sendEmail endpoint is only available to internal consumers:
Audiences for Types
We can mark types for different audiences. In this example, the
Audiences for Properties
We can mark the properties of a type for different audiences. In this example, the
to property is available to beta consumers: