What problem does it solve?
It reduces the risk of outdated or incorrect API documentation by turning your codebase into a validated OpenAPI specification with breaking-change protection.
Core Features & Use Cases
- Inventory-first endpoint mapping: Extracts methods, paths, params, request/response shapes, status codes, and auth requirements directly from the codebase.
- OpenAPI generation with reusable components: Produces OpenAPI 3.1 specs with grouped tags, shared schemas, and matching security schemes.
- Validation and documentation output: Ensures schema constraints align with real serialized output and generates human-readable documentation with examples.
- Release safety via oasdiff: Wires an
oasdiff breaking-change CI gate to prevent breaking changes to stable endpoints.
Quick Start
Ask the AI to scan your repository endpoints and generate an OpenAPI 3.1 spec (openapi.yaml), including schema validation and an oasdiff breaking-change CI gate wired to your stable endpoints policy.