audit-api-consistency
Audit API Consistency
Overview
Scan the codebase for API route definitions and analyze them for consistency across naming, HTTP method usage, error response shapes, pagination, auth patterns, and versioning. Produce a structured report with severity-rated findings and concrete fix recommendations. This is an audit skill -- it analyzes what exists, it does not create new APIs.
Workflow
-
Read project context -- Read
.chalk/docs/engineering/for:- Existing API design documents that define the intended conventions
- Architecture docs describing the API layer
- Any API style guides or conventions documents
- Prior audit reports to check if previously flagged issues were resolved
-
Discover route definitions -- Scan the codebase to find all API endpoints:
- Use Grep to search for route registration patterns:
- Express/Koa:
router.get,router.post,app.use, etc. - Django:
path(,url(,@api_view - Spring:
@GetMapping,@PostMapping,@RequestMapping
- Express/Koa:
- Use Grep to search for route registration patterns:
More from generaljerel/chalk-skills
python-clean-architecture
Clean architecture patterns for Python services — service layer, repository pattern, domain models, dependency injection, error hierarchy, and testing strategy
23create-handoff
Generate a handoff document after implementation work is complete — summarizes changes, risks, and review focus areas for the review pipeline. Use when done coding and ready to hand off for review.
16create-review
Bootstrap a local AI review pipeline and generate a paste-ready review prompt for any reviewer agent. Use after creating a handoff or when ready to get an AI code review.
15fix-findings
Fix findings from the active review session — reads reviewer findings files, applies fixes by priority, and updates the resolution log. Use after pasting reviewer output into findings files.
15fix-review
When the user asks to fix, address, or work on PR review comments — fetch review comments from a GitHub pull request and apply fixes to the local codebase. Requires gh CLI.
15review-changes
End-to-end review pipeline — creates a handoff, generates a review (self-review or paste-ready for another provider), then offers to fix findings. Use when you want to review your changes before pushing.
13