skills.rest
a35506322
a35506322COMMUNITY
Explore all skills by this author →
GitHub

create-api-spec

Extract API specification metadata from endpoint source code into Markdown files.

1|Updated Jan 25, 2026
Search Tags:#api specification#markdown generation#framework agnostic#backend documentation#code to doc#endpoint analysis
One-click install
npx skills add https://github.com/a35506322/Lab.Todo --skill create-api-spec
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-api-spec
Source: https://github.com/a35506322/Lab.Todo/tree/main/.cursor/skills/create-api-spec
Command: npx skills add https://github.com/a35506322/Lab.Todo --skill create-api-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious, error-prone manual work of writing API specification documents from scratch when you already have the endpoint source code, saving development teams hours of repetitive documentation effort.

Core Features & Use Cases

  • Framework-Agnostic Support: Works with any major backend framework including .NET, Node.js, Python, Java, and Go, automatically adapting extraction logic to match each framework's routing and annotation patterns.
  • Automated Metadata Extraction: Pulls all 8 critical pieces of API information (HTTP method, full URL, auth requirements, path/query/body parameters, success/error responses, example payloads) directly from endpoint source code with no manual lookup required.
  • Standardized Spec Output: Generates consistently formatted Markdown spec files with correct file:// source code links, unified error envelope formatting, and kebab-case file naming, ready to integrate into your project documentation.
  • Use Case Example: For a .NET Minimal API endpoint like GetTodoByIdEndpoint.cs, this Skill automatically produces a full spec doc with all request parameters, response schemas, error codes, and linked source references in seconds.

Quick Start

Use the create-api-spec skill to generate a complete API specification document for the endpoint located at src/TodoAPI/Modules/Todo/GetTodoById/GetTodoByIdEndpoint.cs.

Frequently Asked Questions about create-api-spec

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

FAQPage Schema
How do I generate API specification docs from endpoint source code?▼

You can generate API specification docs from endpoint source code by using automated extraction logic that parses routing annotations to output standardized Markdown files with parameters, response schemas, and source links.

Does automated API documentation work with Node.js, Python, Java, and Go frameworks?▼

Automated API documentation supports framework-agnostic extraction for Node.js, Python, Java, Go, and .NET by adapting to each framework's routing and annotation patterns to accurately pull endpoint metadata.

What metadata is included in an automatically generated API spec Markdown file?▼

An automatically generated API spec Markdown file includes eight critical pieces of endpoint metadata: HTTP method, full URL, auth requirements, path/query/body parameters, success/error responses, and example payloads.

What is the best way to document backend APIs without manual lookup?▼

The best way to document backend APIs without manual lookup is using framework-adaptive extraction logic that automatically pulls critical endpoint information and outputs consistently formatted Markdown spec files with file source links.

Can I extract error response codes and example payloads directly from my existing endpoint files?▼

Yes, you can extract error response codes and example payloads directly from existing endpoint files. The extraction process captures unified error envelope formatting and success responses alongside request parameters.

Related Skills

Explore More Software Engineering Skills→
yaochangyuyaochangyu

security-check-dependencies

Identify and report known vulnerabilities in project dependencies across multiple ecosystems.

Community
Intermediate
dthuy62dthuy62

ck:project-organization

Organize project files into standardized folders with kebab-case naming and markdown templates.

Community
Advanced
Camilo8902Camilo8902

vscode-rest-client-generator

Generate .http files for VS Code REST Client from API route definitions.

Community
Intermediate
FlexasaurusrexFlexasaurusrex
16

feishu-doc

Read, write, append, and manipulate blocks in Feishu documents.

Community
Intermediate