Display SDK snippets

If you use Fern’s SDK Generator, you can automatically show SDK code snippets in your API Reference. SDK languages appear in a drop-down. By default, cURL snippets will be displayed to users.

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. In the following example, we’ll use your-organization as the package name because it is a common practice. For example, Stripe calls their npm package stripe and Twilio calls their PyPI package twilio.

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, add package-name: your-package-name to the output section.
• For Go, add repository: your-organization/your-repository to the github section.

1
groups:
2
  production:
3
    generators:
4
      - name: fernapi/fern-python-sdk
5
        version: 2.8.0
6
        output:
7
          location: pypi
8
          token: ${PYPI_TOKEN}
9
          package-name: your-package-name # <--- add this field
10
        ...
11
     - name: fernapi/fern-typescript-node-sdk
12
        version: 0.20.9
13
        output:
14
          location: npm
15
          token: ${NPM_TOKEN}
16
          package-name: your-package-name # <--- add this field
17
     - name: fernapi/fern-ruby-sdk
18
        version: 0.6.3
19
        output:
20
          location: rubygems
21
          token: ${RUBYGEMS_TOKEN}
22
          package-name: your-package-name # <--- add this field
23
     - name: fernapi/fern-go-sdk
24
        version: 0.22.0
25
        github:
26
          repository: your-organization/your-repository # <--- add this field
27
        ...        

Add the package name to your docs configuration

Add the package name for the corresponding SDK to your docs.yml file:

• For Python, TypeScript, and Ruby, your-package-name must match the your-package-name that you configured in your generators.yml file.
• For Go, use the exact URL where the SDK repository is located, including the https://github.com/.

1
navigation:
2
  - api: API Reference
3
    snippets:
4
      python: your-package-name  # <--- needs to match the naming in generators.yml
5
      typescript: your-package-name # <--- needs to match the naming in generators.yml
6
      ruby: your-package-name # <--- needs to match the naming in generators.yml
7
      go: https://github.com/your-organization/your-repository # <--- needs the https://github.com/ prefix

Trigger generation

As the final step, trigger your docs generation by running fern generate --docs locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a drop-down!

Set default snippet language

SDK code snippets support several languages. Our development work is driven by customer requests, so please request support for languages not listed here by opening an issue.

• csharp
• curl
• dotnet
• go
• java
• javascript
• python
• ruby
• typescript

To set the default snippet language, use the default-language key at the top indentation level of docs.yml.

1
default-language: typescript
2
3
navigation:
4
  - api: API Reference
5
    snippets:
6
      python: your-package-name 
7
      typescript: your-package-name

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.