hatch3r-api-spec
OfficialGenerate accurate OpenAPI specs with CI gates.
Software Engineering#openapi#schema validation#api documentation#api specification#ci gate#oasdiff#endpoint inventory
Authorhatch3r
Version1.0.0
Installs0
System Documentation
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
oasdiffbreaking-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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: hatch3r-api-spec Download link: https://github.com/hatch3r/hatch3r/archive/main.zip#hatch3r-api-spec Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.