api-documentation

Detects API code changes and enforces synchronization with Swagger/OpenAPI documentation.

Updated Jan 1, 2026
One-click install
npx skills add https://github.com/sarkarshivaditya-lab/WellMate --skill api-documentation-sarkarshivaditya-lab
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/sarkarshivaditya-lab/WellMate/tree/main/.engineering-skills/troykelly-claude-skills/skills/api-documentation
Command: npx skills add https://github.com/sarkarshivaditya-lab/WellMate --skill api-documentation-sarkarshivaditya-lab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? API documentation frequently drifts out of sync with actual code as endpoints are added or modified, leaving consumers with stale or missing specs. This Skill monitors API-related file changes and pauses work until Swagger/OpenAPI documentation matches the code. ## Core Features & Use Cases - Drift Detection: Compares endpoints found in route, controller, and handler files against paths defined in openapi.yaml or swagger.json. - Pause-and-Audit Workflow: When drift is detected, work pauses and the documentation-audit skill is invoked to resynchronize documentation. - Documentation Standards: Enforces required OpenAPI fields including summaries, request/response schemas, examples, and security definitions, with validation via swagger-cli. - Use Case: A developer adds a new POST endpoint to an Express routes file; the Skill detects the change, finds it missing from openapi.yaml, pauses the workflow, and triggers a documentation update before work resumes. ## Quick Start Check whether my recent API route changes are reflected in the OpenAPI documentation and update it if anything is missing.

Frequently Asked Questions about api-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep OpenAPI documentation in sync with code changes?

Detect API file changes with git diff, extract endpoints from route and controller files, then compare them against paths in openapi.yaml. When endpoints exist in code but not in docs, pause work and update the specification before continuing.

What file patterns trigger API documentation checks?

The check triggers on changes to routes, controllers, api directories, handlers, schema files, DTOs, and model files across TypeScript, Python, and Go projects. Patterns include *.controller.ts, *_router.py, and files under handlers/ directories.

Which frameworks does API documentation sync support?

It supports Express, Fastify, and NestJS in TypeScript, FastAPI and Flask in Python, and Go HTTP handlers. Documentation files recognized include openapi.yaml, openapi.json, swagger.yaml, swagger.json, and variants under docs/ or api/ directories.

How do I validate an OpenAPI specification file?

Run npx @apidevtools/swagger-cli validate openapi.yaml to fully validate the spec. For a quick structural check, use yq to confirm the file contains openapi, paths, and info top-level keys.

When should API documentation checks be skipped?

Skip the check when changes are purely internal with no API surface impact, when only test files or documentation itself changed, or when the project has no API such as CLI tools and libraries.