OpenAPI Generator

Generating docs for OpenAPI schema

Usage

Install the required packages.

npm install fumadocs-openapi

Create configuration file:

openapi.config.js

/**
 * @type {import("fumadocs-openapi").Config}
 */
module.exports = {
  input: ['./petstore.yaml'],
  output: './content/docs',
};

Only OpenAPI 3.0 is supported.

It doesn't allow JSON schema specific keywords like const, as they are unsupported

Generate docs with a command:

pnpm fumadocs-openapi

Last updated on

Twoslash

Demo Museum API