Install

Already have an OpenAPI spec?

Import your OpenAPI spec into Fern here.

The fern/ directory

The fern/ directory contains your Fern configuration. This generally lives in your backend repo, but you can also have an independent repo dedicated to your API (like Seam's).

In the root of your repo, run:

This will create the following folder structure in your project:

Generating an SDK

To generate the TypeScript SDK and an OpenAPI spec, run:

By default, generators.yml is configured to generate a TypeScript SDK and an OpenAPI spec. You can read more about generation on the fern generate page.

Defining your API

Your Fern Definition is a set of YAML files that describe your API. You can learn more about this in the Define your API section.