generateFiles()

The generateFiles() function generates MDX files for API documentation.

Note that the page content is still rendered by the APIpage component, docs generator only arranges the endpoints/webhooks to render for each page.

Usage

It takes an OpenAPI instance.

import { generateFiles } from 'fumadocs-openapi';
import { openapi } from '@/lib/openapi';

void generateFiles({
  input: openapi,
  // The output directory.
  output: '/content/docs',
});

`per`

Customize the content of pages, default to operation.

Operation refers to an API endpoint with specific method like /api/weather:GET.

mode	content	file path
tag	operations with same tag	`{tag_name}.mdx`
file	operations in same schema file	`{file_name}.mdx`
operation	each operation	`{operationId ?? endpoint_path}.mdx`)
custom	see below	N/A

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  per: 'tag',
});

When set to custom, you can pass a function to fully customize the generation process:

Example

import { generateFiles, OperationOutput } from 'fumadocs-openapi';

void generateFiles({
  per: 'custom',
  toPages(builder) {
    const items = builder.extract();

    for (const op of items.operations) {
      const { pathItem, operation, displayName } = builder.fromExtractedOperation(op)!;

      const entry: OperationOutput = {
        type: 'operation',
        schemaId: builder.id,
        item: op,
        path: '...',
        info: {
          title: displayName,
          description: operation.description ?? pathItem.description,
        },
      };

      builder.create(entry);
    }
  },
});

When set to tag, adding x-displayName to the tag definition can control the title of each page.

openapi.yaml

tags:
  - name: test
    description: this is a tag.
    x-displayName: My Test Name

`groupBy`

In operation mode, you can group output files with folders.

value	output
tag	`{tag}/{operationId ?? endpoint_path}.mdx`
route	`{endpoint_path}/{method}.mdx` (ignores `name` option)
none (default)	`{operationId ?? endpoint_path}.mdx`

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  per: 'operation',
  groupBy: 'tag',
});

`index`

Generate index files with cards linking to generated pages.

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  index: {
    // for generating `href`
    url: {
      baseUrl: '/docs',
      contentDir: './content/docs',
    },
    items: [
      {
        // output path
        path: 'index.mdx',
        // optional: restrict the input files (identical to the `input` field in server)
        only: ['petstore.yaml'],
        // optional: set frontmatter
        description: 'All available pages',
      },
    ],
  },
});

`meta`

Generate meta.json files automatically.

You can always define the meta.json files manually for maximal flexibility.

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  meta: true,

  // or customize how folders are represented:
  meta: {
    folderStyle: 'separator',
  },
});

`imports`

Add custom imports to generated MDX files. This is useful for including components, utilities, or other dependencies in your generated documentation.

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  imports: [
    {
      names: ['API_BASE_URL'],
      from: '@/constants',
    },
  ],
});

This will add the following imports to all generated MDX files:

import { API_BASE_URL } from '@/constants';

`name`

A function that controls the output file name of MDX pages.

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  name(output) {
    const doc = this.document;
    if (output.type === 'operation') {
      const operation = doc.paths![output.item.path]![output.item.method]!;
      // operation object
      console.log(operation);

      return 'my-dir/filename';
    }

    const hook = this.dereferenceShallow(doc.webhooks![output.item.name])[output.item.method]!;
    // webhook object
    console.log(hook);
    return 'my-dir/filename';
  },
});

`frontmatter`

Customize the frontmatter of MDX files.

By default, it includes:

property	description
`title`	Page title
`description`	Page description
`full`	Always true, added for Fumadocs UI
`_openapi`	Internal Properties

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  frontmatter: (title, description) => ({
    myProperty: 'hello',
  }),
});

`addGeneratedComment`

Add a comment to the top of generated files indicating they are auto-generated.

import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  // Add default comment
  addGeneratedComment: true,

  // Or provide a custom comment
  addGeneratedComment: 'Custom auto-generated comment',

  // Or disable comments
  addGeneratedComment: false,
});

On this page