Auto API docs: connect OpenAPI / repo, AI-written reference + guides

FeatureOpenView on roadmap· 4 days ago

Imported from GitHub issue El-SaMa/hollahoop#108 by @El-SaMa.

Connect an API and get a full, AI-friendly docs section that stays in sync.

Sources: OpenAPI 3 URL, file in a connected GitHub repo (re-sync on push/release), or upload; later: GraphQL introspection, WP REST discovery (/wp-json)
Generated: one reference page per endpoint (params, schemas, errors, auth), request/response examples, code samples (curl, JS, PHP, Python), searchable, versioned with the existing docs versions
AI layer: writes overview, quickstart, auth guide and per-tag guides from the spec; flags undocumented endpoints; rewrites through the publish guard (no secrets/internal hosts in examples)
AI-oriented output: /llms.txt + /llms-full.txt and markdown export per page; MCP tools import_openapi / get_api_reference so agents can read the API
Try-it console with project API key (optional)
Diff on re-sync: new/changed/removed endpoints become a draft changelog entry Dogfood with Hollahoop's own /api/v1 OpenAPI and a LAFU plugin REST API.

Comments (0)

No comments yet.

Join the discussion