@restdocs/generators

Output generators for @restdocs - OpenAPI, Markdown, and TypeScript.

Installation

npm install @restdocs/generators

Supported Formats

OpenAPI 3.0

import { generateOpenAPI } from '@restdocs/generators/openapi';

const spec = generateOpenAPI(docs, {
    info: {
        title: 'My API',
        version: '1.0.0',
    },
});

Markdown

import { generateMarkdown } from '@restdocs/generators/markdown';

const markdown = generateMarkdown(docs);

TypeScript

import { generateTypeScript } from '@restdocs/generators/typescript';

const types = generateTypeScript(docs);

Features

• 📄 OpenAPI 3.0 specification generation
• 📝 Clean Markdown documentation
• 🔷 TypeScript interface generation
• 🎯 Multiple output formats from single source

Documentation

See main documentation for full generator options.

License

MIT