skills.rest
cardinalconseils
cardinalconseilsCOMMUNITY
Explore all skills by this author →
GitHub

api-docs

Detect API endpoints across frameworks and generate Markdown or OpenAPI docs.

3|Updated Mar 16, 2026
Search Tags:#documentation#markdown#openapi#endpoints#generate#api-docs
One-click install
npx skills add https://github.com/cardinalconseils/claude-starter --skill api-docs-cardinalconseils
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/cardinalconseils/claude-starter/tree/main/skills/api-docs
Command: npx skills add https://github.com/cardinalconseils/claude-starter --skill api-docs-cardinalconseils

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Scans the codebase to identify API endpoints and generate structured documentation across Markdown and OpenAPI formats, reducing manual doc effort and maintaining consistency.

Core Features & Use Cases

  • Endpoint Detection: automatically discover API routes across Express, Next.js, FastAPI, Flask, Django REST, and more.
  • Schema Extraction: infer request/response schemas and authentication requirements from code.
  • Output Formats: generate Markdown docs and OpenAPI 3.0 specs for tooling and docs.
  • Lifecycle Integration: supports post-sprint and pre-release documentation to align with API contracts.

Quick Start

Scan the repository to detect API endpoints and generate comprehensive documentation in Markdown or OpenAPI.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate API documentation from my codebase automatically?▼

To generate API documentation automatically, this Skill scans your codebase to detect endpoints, extract schemas, and output Markdown or OpenAPI specs without manual effort.

Does endpoint detection work with FastAPI, Flask, and Django REST frameworks?▼

Endpoint detection works with FastAPI, Flask, and Django REST, automatically discovering API routes across these frameworks and others like Express and Next.js.

Can I export an OpenAPI 3.0 spec from my codebase for tooling integration?▼

You can export an OpenAPI 3.0 spec from your codebase; the Skill infers schemas and authentication from code to generate OpenAPI output formatted for tooling.

When do I need to generate API docs during the development lifecycle?▼

You need to generate API docs during post-sprint development or pre-release stages to ensure endpoints are documented and aligned with the API contract.

What is the best way to document Express and Next.js API endpoints?▼

The best way to document Express and Next.js endpoints is scanning the codebase to infer schemas, producing structured Markdown or OpenAPI 3.0 specs automatically.

Related Skills

Explore More Software Engineering Skills→
igpastorigpastor

API Design Skill

Generate framework-specific API endpoints with routes, controllers, and OpenAPI documentation.

Community
Intermediate
Lautaro073Lautaro073

api-reference-documentation

Generates endpoints, models, and authentication details from OpenAPI 3.0 documents into Markdown-ready content.

Community
Intermediate
Vivekmano27Vivekmano27

api-docs-generator

Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.

Community
Advanced
EthansuttorEthansuttor

agent-docs-api-openapi

Generate and maintain OpenAPI 3.0 specifications for APIs with endpoints, schemas, and security definitions.

Community
Advanced