For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site-level settings
    • Page-level settings
  • Writing content
    • Markdown basics
    • Rich media in Markdown
    • Fern Editor
    • Reusable snippets
  • AI features
    • Overview
    • Fern Writer
    • AI-generated examples
    • Markdown access
      • Overview
      • Customize LLM output
      • Agent directives
      • Analytics and integration
    • MCP server
    • API catalog discovery
      • Overview
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • OpenRPC Reference
        • gRPC Reference
        • GraphQL Reference
        • Library Reference
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free
On this page
  • Configuration
  • Include more than one API Reference
API ReferencesGeneration

Generate REST API Reference

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Overview of API References

Next

Generate Webhook Reference

Fern generates REST API Reference documentation from an OpenAPI specification. Once the API definition is set up, adding it to the docs takes just one line of configuration.

Fern also supports gRPC, WebSocket, OpenRPC, and Webhook references.

Configuration

1

Set up your project structure

Add your specification file to your /fern directory and create a generators.yml that references it in the api.specs section:

generators.yml
1api:
2 specs:
3 - openapi: "./openapi.yml"
2

Add the API Reference to your navigation

Add - api: API Reference to your navigation in docs.yml:

docs.yml
1navigation:
2 - api: API Reference

Fern will automatically populate your endpoints, types, and code snippets from your API definition. Request and response examples are generated using AI to show realistic data instead of placeholder values.

3

Customize the layout

For a full list of configuration options and layout customizations, see Customize API Reference layout.

Include more than one API Reference

To include multiple, distinct API definitions in your documentation, use the api-name property. The api-name corresponds to the folder name containing your API definition. For example:

fern
fern.config.json
docs.yml
plant-api
openapi.yml# OpenAPI spec
generators.yml# References the OpenAPI spec
garden-api
openapi.yml# OpenAPI spec
generators.yml# References the OpenAPI spec
Flat layout
Tabbed layout

For a simple setup without tabs, you can include multiple API References directly in your navigation:

docs.yml
1navigation:
2 - api: Plant Store
3 api-name: plant-api # Matches folder name containing your API definition
4 - api: Garden
5 api-name: garden-api # Matches folder name containing your API definition