Generate your API Reference
A key benefit of using Fern Docs is that once you’ve defined your API, you get your API Reference documentation with just one line.
Add - api: API Reference
to your navigation in docs.yml
and Fern takes care of the rest! You’ll see your endpoints, types,
and cURL snippets automatically populated from your OpenAPI Specification or Fern Definition.
Example:
API Reference configuration options
More on customizing your API Reference here.
Include more than one API Reference
To include multiple, distinct API definitions in your documentation, you can indicate which to include using the api-name
property. The api-name
corresponds to the name of the folder where your API definition is housed.
For example, your file structure might look like this:
For a simple setup without tabs, you can include multiple API references directly in your navigation:
When using tabs, each API reference must be placed within a tab’s layout
: