skills.rest
crgarcia12
crgarcia12COMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-extractor

Extract API contracts from web framework source code into OpenAPI-compatible YAML.

Updated May 6, 2026
Search Tags:#code analysis#api#openapi#api documentation#contract extraction
One-click install
npx skills add https://github.com/crgarcia12/compy --skill api-extractor-crgarcia12
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-extractor
Source: https://github.com/crgarcia12/compy/tree/main/.github/skills/api-extractor
Command: npx skills add https://github.com/crgarcia12/compy --skill api-extractor-crgarcia12

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the extraction of API contracts from existing code, providing a factual and comprehensive documentation of the API surface without any editorial judgment.

Core Features & Use Cases

  • API Contract Extraction: Extracts routes, endpoints, request/response schemas, and authentication patterns from code.
  • Framework Support: Works with various web frameworks like Express, Fastify, NestJS, and Django.
  • Output Format: Outputs contracts in OpenAPI-compatible YAML format for easy integration with other tools.
  • Use Case: Ideal for developers and API documentation maintainers who need to keep API documentation in sync with code changes.

Quick Start

Run the api-extractor skill on your project source tree to generate API contracts.

Frequently Asked Questions about api-extractor

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

FAQPage Schema
How do I extract API contracts from source code automatically?▼

Extract API contracts from source code by running an automated analysis process that identifies routes, endpoints, request and response schemas, and authentication patterns directly from your codebase.

Can I generate OpenAPI documentation from an existing NestJS or Django project?▼

Yes, you can generate OpenAPI-compatible YAML documentation from existing NestJS or Django projects by scanning the source tree to map framework-specific routes to an API contract.

What is the best way to keep API documentation in sync with code changes?▼

The best way to keep API documentation in sync with code changes is to automate contract extraction directly from the source code, ensuring factual alignment without relying on manual editorial updates.

Does API contract extraction work with Fastify and Express frameworks?▼

Yes, API contract extraction works with Fastify and Express frameworks, analyzing the codebase to accurately identify and document API endpoints across these multiple web frameworks.

What format is used for the extracted API endpoints and schemas?▼

The extracted API endpoints and schemas are output in OpenAPI-compatible YAML format, which ensures easy integration with other API documentation and testing tools.

Why do I need framework knowledge to extract API routes accurately?▼

Framework knowledge is required to extract API routes accurately because the tool must understand framework-specific implementations to correctly identify and document endpoints across diverse codebases.

Related Skills

Explore More Software Engineering Skills→
drvossdrvoss
42

api-documentation

Generate OpenAPI-compatible specs from source code for REST and GraphQL APIs.

Community
Intermediate
YokhanYokhan

modify-api

Update API endpoint contracts, implementations, tests, and documentation.

Community
Advanced
bomberoxenviosdosruedasbomberoxenviosdosruedas

agency-devops-automator

Automate DevOps workflows with Terraform, GitHub Actions, Kubernetes, and Prometheus.

Community
Advanced
mgd34msumgd34msu
4

openapi

Generate TypeScript types and client SDKs from OpenAPI 3.1 specifications.

Community
Advanced