@apivexa/pipeline

End-to-end orchestration — one call from OpenAPI source to validated Markdown guide.

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

Install

npm install @apivexa/pipeline

Usage

import { generateGuide } from '@apivexa/pipeline';

const result = await generateGuide(
  { type: 'file', path: './openapi.yaml' },
  {
    baseUrl: 'https://api.example.com',       // optional override
    languages: ['curl', 'python'],             // optional — default: all 8
    maxCodeExamplesPerEndpoint: 3,             // optional
  },
);

console.log(result.markdown);          // full Markdown guide string
console.log(result.validation.valid);  // true
console.log(result.aiCallCount);       // 0 (with default NullAiProvider)

What generateGuide does

InputSource
    → ingest (parse + resolve + validate)
    → analyzeApi
    → planDocumentation
    → generateDocument
    → enrichDocumentWithWorkflows
    → validateDocument
    → renderToMarkdown
    → PipelineResult

All steps run in sequence. The result includes the parsed api, the documentation document IR, the validation report, and the rendered markdown.

Full documentation