Display SDK snippets
When you use Fern’s SDK Generator, you can automatically display SDK code snippets in your API Reference. These snippets appear in a language selector dropdown, with cURL as the default option.
Configuring SDK Snippets
To configure SDK snippets, you’ll need to name your SDKs in generators.yml
and then reference that name in docs.yml
.
Add examples to your API definition
In order to generate code snippets, Fern needs to read request examples from your API definition. If you’re using a Fern Definition, you can follow these instructions. If you’re using an OpenAPI Specification, you can follow these instructions.
Define a package name for your SDK(s)
Configure package names in your generators.yml
file:
- For Python, TypeScript, Ruby, and .NET/C#, add
package-name: your-package-name
to theoutput
section. - For Go, add
repository: your-organization/your-repository
to thegithub
section.
SDK snippets automatically populated in your Fern Docs is a paid feature included in the SDK Basic plan.
Add the package name to your docs configuration
Add the package name for the corresponding SDK to your docs.yml
file:
- For Python, TypeScript, Ruby, and .NET/C#,
your-package-name
must match theyour-package-name
that you configured in yourgenerators.yml
file. - For Go, use the exact URL where the SDK repository is located, including the
https://github.com/
.
To display different package names for SDK users versus documentation users, use overrides files.
Access via API
If you’d like to bring SDK snippets into your own documentation, you can use the Snippets API. API access requires a SDK Business plan or above.
Merge.dev is an example of a Fern customer that uses the Snippets API to bring Python code samples into their API Reference.
Endpoint request and response snippets
Looking for information on generating API endpoint request and response snippets? See our documentation on Endpoint Request Snippets and Endpoint Response Snippets.