@apivexa/generator

Generates every section of an API User Guide from a documentation plan and a NormalizedApi.

Part of ApiVexa — AI-powered API User Guide Generator.

Install

npm install @apivexa/generator

What it generates

• Overview — what the API does and who it is for
• Getting Started — base URL, auth prerequisites, first request
• Authentication — all detected auth schemes with usage examples
• Endpoint Reference — every operation: params, request body, responses, status codes
• Data Models — schemas with types, required fields, enums, and relationships
• Error Handling — every documented status code explained
• Pagination / Filtering — detected from query parameters and response shapes

Usage

import { generateDocument } from '@apivexa/generator';

const document = generateDocument(plan, normalizedApi, {
  baseUrl: 'https://api.example.com',
  languages: ['curl', 'python'],   // code example languages
});

Returns a DocumentIr consumed by @apivexa/renderer.

Full documentation