skills.rest
AdeptMind
AdeptMindOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-documenter

Generate Markdown or OpenAPI documentation from API code endpoints.

Updated Mar 12, 2026
Search Tags:#developer tools#documentation#api#openapi#code generation#swagger
One-click install
npx skills add https://github.com/AdeptMind/pr-emojis-in-slack --skill api-documenter-adeptmind
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documenter
Source: https://github.com/AdeptMind/pr-emojis-in-slack/tree/main/.claude/skills/api-documenter
Command: npx skills add https://github.com/AdeptMind/pr-emojis-in-slack --skill api-documenter-adeptmind

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and updating of API documentation, ensuring that your API specifications are always in sync with your codebase, saving significant developer time and reducing errors.

Core Features & Use Cases

  • Automated Documentation Generation: Creates Markdown or OpenAPI (v3+) documentation from API code.
  • Framework Agnostic: Detects various web frameworks (Express, FastAPI, Django, Spring, Go net/http).
  • Incremental Updates: Merges new documentation with existing files, preserving manual notes.
  • Use Case: After adding new endpoints to your FastAPI application, run this Skill to automatically update your openapi.yaml file and generate a human-readable Markdown overview in docs/api.md.

Quick Start

Use the api-documenter skill to generate documentation for the API code in the './src/routes' directory.

Frequently Asked Questions about api-documenter

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

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

To generate API documentation automatically, this Skill scans your project directories for route definitions, extracts endpoint details, and outputs Markdown or OpenAPI v3+ specifications.

Can I generate OpenAPI specifications from Express or FastAPI code?▼

Yes, you can generate OpenAPI specifications from Express, FastAPI, Django, Spring, or Go net/http code, as the Skill automatically detects these frameworks and extracts route details.

How do I update existing API documentation without losing manual notes?▼

To update existing API documentation without losing manual notes, the Skill merges newly generated endpoint details with your current files and flags discrepancies.

What is the best way to keep API documentation in sync with my codebase?▼

The best way to keep API documentation in sync with your codebase is automating the extraction of endpoint parameters, request bodies, and error codes directly from your route definitions.

Does API documentation generation work without adding annotations to my code?▼

Yes, API documentation generation works without manual annotations by scanning project directories to identify frameworks and gather endpoint details like parameters and responses automatically.

Related Skills

Explore More Software Engineering Skills→
stevengonsalvezstevengonsalvez

find-missing-tests

Detect untested code and generate GitHub issues with acceptance criteria.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
tuyenhttuyenht

Contract Testing

Implement API contract testing for microservices using Pact and OpenAPI.

Community
Advanced
dhruvinrsonidhruvinrsoni

openapi-specs

Generate, validate, and detect drift in OpenAPI specifications from API code.

Community
Advanced