skills.rest
AstyanM
AstyanMCOMMUNITY
Explore all skills by this author →
GitHub

api-docs

Generate OpenAPI, Markdown, or Postman documentation from source code.

1|Updated Feb 11, 2026
Search Tags:#documentation#api#openapi#code generation#rest#swagger#postman
One-click install
npx skills add https://github.com/AstyanM/claude-am-plugin --skill api-docs-astyanm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/AstyanM/claude-am-plugin/tree/main/skills/api-docs
Command: npx skills add https://github.com/AstyanM/claude-am-plugin --skill api-docs-astyanm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of outdated, inconsistent, or manually intensive API documentation by automating its generation directly from the source code. It ensures documentation accurately reflects the current state of the API, saving developers time and reducing errors.

Core Features & Use Cases

  • Automated API Discovery: Scans the codebase to identify API frameworks, endpoints, and their associated methods and paths.
  • Schema Extraction: Extracts detailed request and response schemas, including types, validation rules, and descriptions, from code definitions (e.g., TypeScript interfaces, Pydantic models).
  • Multi-Format Output: Generates API documentation in industry-standard formats such as OpenAPI 3.1 YAML, Markdown API Reference, or Postman Collections.
  • Use Case: A development team needs to provide up-to-date API documentation for a new microservice. They can use this skill to automatically generate an OpenAPI specification and a Markdown reference directly from their code, ensuring consistency and accuracy for consumers.

Quick Start

Use the api-docs skill to generate OpenAPI documentation for the current project's API endpoints.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate OpenAPI documentation directly from my source code?▼

To generate OpenAPI documentation, this skill scans your source code to extract endpoint details, request/response schemas, and validation rules, outputting an OpenAPI 3.1 YAML file that accurately reflects your current API.

Can I extract API schemas from my existing codebase automatically?▼

You can extract API schemas automatically by analyzing code definitions like TypeScript interfaces or Pydantic models to capture types, validation rules, and descriptions directly from your existing codebase.

Does this API documentation generator work with GraphQL and gRPC frameworks?▼

This API documentation generator works with various programming languages and web frameworks, supporting REST, GraphQL, and gRPC APIs to extract endpoint details and schemas from your source code.

What is the best way to create Postman Collections from my code?▼

The best way to create Postman Collections is to analyze your source code to identify API endpoints and schemas, automatically generating a ready-to-use Postman Collection format.

How to generate a Markdown API reference from my codebase?▼

To generate a Markdown API reference, the skill scans your codebase to identify API frameworks and extracts endpoint methods, paths, and schemas, producing a comprehensive Markdown documentation file.

Related Skills

Explore More Software Engineering Skills→
edulazaroedulazaro
12

lc:api-docs

Generate API documentation from Laravel routes, controllers, and form requests.

Community
Intermediate
MathiasPaulenkoMathiasPaulenko

postman-api-automation

Automate API testing with Postman collections and Newman CLI.

Community
Advanced
phuhao00phuhao00
12

code-analyst-agent

Analyze source code to identify symbols, call graphs, and architectural patterns.

Community
Intermediate
Likas07Likas07

technical-writer

Generate developer documentation including READMEs, API references, tutorials, and conceptual guides.

Community
Advanced