@apivexa/analysis

Deterministic API intelligence — authentication detection, resource grouping, and pattern recognition.

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

Install

npm install @apivexa/analysis

Features

• Authentication detection — API Key, Bearer/JWT, OAuth 2.0, OpenID Connect, Basic Auth, Cookie
• Resource grouping — clusters operations by tag or path prefix
• Pattern detection — CRUD, pagination, filtering/sorting, bulk operations, webhooks, versioning
• Fully deterministic — no AI calls, same output for the same input

Usage

import { analyzeApi } from '@apivexa/analysis';

const analysis = analyzeApi(normalizedApi);

console.log(analysis.authSchemes);   // [{ type: 'bearer', name: 'BearerAuth' }]
console.log(analysis.resources);     // [{ name: 'Customers', operations: [...] }]
console.log(analysis.patterns);      // { pagination: true, filtering: true, crud: true }

analyzeApi accepts a NormalizedApi from @apivexa/openapi and returns an ApiAnalysis used by @apivexa/planner and @apivexa/generator.

Full documentation