SDK Configuration

Configure your SDK generators in generators.yml and publish to registries

Before you can configure your generators, you must setup your API Definition. Learn more here

The public schema for generators.yml can be found here.

Top Level Configuration

generators.yml
1default-group: local
2
3readme: 
4  apiReferenceLink: https://plantstore.dev
5  defaultEndpoint: GET /v3/store/inventory
6
7groups: 
8  node: 
9    generators: 
10      - name: fernapi/fern-typescript-node-sdk
11        version: 0.x.x
12        output: 
13          location: npm
14          package-name: "@plantstore/sdk"
15          token: ${NPM_TOKEN}
16        config: 
17          outputSourceFiles: true
18        github: 
19          repository: "plantstore/plantstore-js"
20        metadata: 
21          package-description: JavaScript library for the Plant Store API Service
22          license: MIT
23  python: 
24    generators: 
25      - name: fernapi/fern-python-sdk
26        version: 0.x.x
27        output: 
28          location: pypi
29          package-name: "plantstore"
30          token: ${PYPI_TOKEN}
31        config: 
32          outputSourceFiles: true
33        github: 
34          repository: "plantstore/plantstore-python"
default-group
string

The default group of generators to run when running fern generate.

readme
object

Learn more about the README configuration here.

groups
map<string, GroupConfiguration>

A set of key-value pairs from the group id to the group configuration.

README Configuration

generators.yml
1readme: 
2  apiReferenceLink: https://plantstore.dev
3  defaultEndpoint: GET /v3/store/inventory
readme.apiReferenceLink
string

A link to your hosted API Reference. Fern will embed this link into your generated READMEs so that SDK users know to navigate to your API Reference.

readme.defaultEndpoint
ReadMe Configuration

The endpoint you want to use in README code samples. If unspecified, Fern will default to the first POST request.

Specify Package Metadata

generators.yml
1metadata: 
2  package-description: Python library for the Plant Store API Service
3  license: Apache
generator.metadata.package-description
string

The decription you’d like the package manager, such as NPM or PyPI, to include.

generator.metadata.license
License

The license you’d like to apply to the code published to GitHub. Options include MIT or Apache (Apache 2.0). To request a new license, open a GitHub Issue.