skills.rest
Yusufkotavom
YusufkotavomCOMMUNITY
Explore all skills by this author →
GitHub

api-inventory-maintenance

Extract API endpoints from *.controller.ts files and update the inventory markdown.

Updated Mar 26, 2026
Search Tags:#documentation#api#sync#controller#endpoint#inventory#handover
One-click install
npx skills add https://github.com/Yusufkotavom/AiToEarn --skill api-inventory-maintenance
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-inventory-maintenance
Source: https://github.com/Yusufkotavom/AiToEarn/tree/main/skills/api-inventory-maintenance
Command: npx skills add https://github.com/Yusufkotavom/AiToEarn --skill api-inventory-maintenance

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Centralize and keep API endpoint documentation consistent across multiple services by automatically extracting endpoint definitions from source controllers and refreshing a unified inventory.

Core Features & Use Cases

  • Automated Endpoint Extraction: Parse *.controller.ts files to capture method, path, and source line information.
  • Cross-Project Grouping: Organize endpoints by application (aitoearn-ai, aitoearn-server, worker).
  • Inventory Synchronization: Update the API inventory markdown and align architecture docs when domain changes occur.
  • Audit & Handover Support: Provide a reliable baseline for handover and audits by listing endpoints with generation timestamps.
  • Guardrails: Enforce immutability of endpoint paths unless source changes are evidenced and flag ambiguous routes.

Quick Start

Run the inventory maintenance workflow whenever you modify an endpoint to automatically refresh the API inventory document.

Frequently Asked Questions about api-inventory-maintenance

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

FAQPage Schema
How do I keep API endpoints synchronized across multiple backend services?▼

API endpoint synchronization across multiple services is achieved by automatically extracting endpoint definitions from source controllers and refreshing a unified inventory markdown to ensure consistency.

What is the best way to extract API routes from *.controller.ts files for documentation?▼

Extracting API routes from *.controller.ts files involves parsing the source code to capture the HTTP method, path, and source line information, then grouping the endpoints by application for the inventory.

How do I audit API endpoints for a project handover?▼

Auditing API endpoints for a project handover requires listing the extracted routes with generation timestamps to provide a reliable baseline, ensuring no critical endpoints are missed during the transition.

Can I use this approach to validate API contracts against architecture documents?▼

Validating API contracts against architecture documents is supported by comparing the extracted endpoint inventory with architectural documents to prevent missed critical endpoints and align domain changes.

What happens to API inventory documentation when an endpoint path changes?▼

When an endpoint path changes, the API inventory documentation enforces immutability of paths unless source changes are evidenced, automatically flagging ambiguous routes to prevent undocumented modifications.

Related Skills

Explore More Software Engineering Skills→
RemseyMailjardRemseyMailjard

wiki-qa

Analyze code repositories to answer questions with source-file citations.

Community
Advanced
davidrrowleydavidrrowley

azure-resource-visualizer

Analyze Azure resource groups and generate Mermaid architecture diagrams with resource inventories.

Community
Advanced
oci-ai-incubationsoci-ai-incubations
3

sync-versions

Extract container image tags from blueprint_files.tf and update SOFTWARE_VERSIONS.md.

Official
Intermediate
hpsgdhpsgd

write-api-docs

Generate API reference documentation from code, OpenAPI specs, and endpoint implementations.

Official
Advanced