@apivexa/examples

Code example engine — generates working API call examples in 8 languages from an OpenAPI spec.

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

Install

npm install @apivexa/examples

Supported languages

curl · javascript · typescript · python · java · go · php · csharp

Examples are derived directly from the OpenAPI contract — HTTP method, URL, parameters, headers, auth, request body, and content type. No fields are invented.

Usage

import { generateExamples, ALL_LANGUAGES } from '@apivexa/examples';

const examples = generateExamples(operation, {
  languages: ['curl', 'python', 'javascript'],   // omit for all 8
  baseUrl: 'https://api.example.com',
  securitySchemes: api.securitySchemes,
});

for (const ex of examples) {
  console.log(`--- ${ex.language} ---`);
  console.log(ex.code);
}

Available languages constant

import { ALL_LANGUAGES } from '@apivexa/examples';
// ['curl', 'javascript', 'typescript', 'python', 'java', 'go', 'php', 'csharp']

Full documentation