Skip to content
Last updated

apiFunctions

Products:ReefReefRealmRealm
Plans:ProEnterpriseEnterprise+

Use the apiFunctions option to set paths where Redocly detects and hosts API functions.

By default, API functions are hosted at the @api folder and the path is served at /api.

Options

OptionTypeDescription
folders[string]List of paths where the API functions are stored.
Default value: /@api

Example

redocly.yaml
apiFunctions:
  folders:
    - /my/api/folder/path/
    - /my/second/api/folder/path/

When you add this configuration to your project, the API functions are located in the /my/api/folder/path/ and /my/second/api/folder/path/ folders as well as the /@api folder. All the endpoints in these folders are available at /my/api/folder/path/... and /my/second/api/folder/path/..., respectively.

This configuration describes the following folder structure:

/
├──my/api/folder/path/
│   ├──hello.ts
│   └──communities/
│       └──[id].get.ts
├──my/second/api/folder/path/
│   ├──world.ts
│   └──books/
│       └──[id].get.ts

The corresponding API endpoints are:

  • /my/api/folder/path/hello
  • /my/api/folder/path/communities/[id]
  • /my/second/api/folder/path/world
  • /my/second/api/folder/path/books/[id]

Resources

  • API functions reference - Complete reference for available API functions and their implementation in your documentation projects
 
Next page