api-documentation-sync
Installation
SKILL.md
API Documentation Sync
Two modes: Generate (routes → spec) or Validate (spec ↔ routes). Identify which mode applies before proceeding.
Phase 1: Discovery
Route extraction — non-obvious patterns to catch
Most routes are not just app.get(...). Scan for:
- Router mounts:
app.use('/prefix', router)— the prefix compounds. Reconstruct full paths. - Dynamic registrations: routes registered in loops, from config arrays, or via decorators — trace the source data.
- Middleware-as-route: auth middleware on
router.use(...)that also terminates requests (e.g., returns 401) — these are implicit endpoints. - Nested routers: routers mounted on routers. Build a full prefix chain.
- Framework-specific: NestJS
@Controller+@Get/@Postdecorators; FastAPIAPIRouter; Djangourlpatternswithinclude(); Hono.route().