api-documentation-generator SKILL.md skillA

api-documentation-generator from sickn33/agentic-awesome-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add sickn33/agentic-awesome-skills/api-documentation-generator@git:20260729.2d74b64

Pins git:20260729.2d74b64 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
sickn33/agentic-awesome-skills
Path
plugins/agentic-awesome-skills-claude/skills/api-documentation-generator/SKILL.md
Versions recorded
2
Latest version
git:20260729.2d74b64, committed Jul 29, 2026
First version recorded
Jul 8, 2026
Size
11,562 bytes
Repository stars
49,308
License
MIT

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# API Documentation Generator

## Overview

Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines.

Perfect for REST APIs, GraphQL APIs, and WebSocket APIs.

## When to Use This Skill

- Use when you need to document a new API
- Use when updating existing API documentation
- Use when your API lacks clear documentation
- Use when onboarding new developers to your API
- Use when preparing API documentation for external users
- Use when creating OpenAPI/Swagger specifications

## How It Works

### Step 1: Analyze the API Structure

First, I'll examine your API codebase to understand:
- Available endpoints and routes
- HTTP methods (GET, POST, PUT, DELETE, etc.)
- Request parameters and body structure
- Response formats and status codes
- Authentication and authorization requirements
- Error handling patterns

### Step 2: Generate Endpoint Documentation

For each endpoint, I'll create documentation including:

**Endpoint Details:**
- HTTP method and URL path
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add sickn33/agentic-awesome-skills/api-documentation-generator@sha256:7f31a889c229573a

The line at the top of this page pins the label git:20260729.2d74b64, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_kuxus64kej2463tc.svg)](https://markdownregistry.com/a/art_kuxus64kej2463tc)

6 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Jul 8, 2026 and Jul 29, 2026, about one every 21 days.

versioncommittedcommitsizeaudit
git:20260729.2d74b64 latest2026-07-29 2d74b64 11,562 BA view · diff
git:20260708.a07936c2026-07-08 a07936c 11,561 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (11562 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

sickn33/agentic-awesome-skills · 49,308 stars · license MIT · pushed 2026-11-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_kuxus64kej2463tc
GET https://markdownregistry.com/api/v1/resolve?ref=sickn33/agentic-awesome-skills/api-documentation-generator
GET https://markdownregistry.com/api/v1/blob/7f31a889c229573a5b6d9b48a113744a8422eba9c14d56047a471277342cb93e

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from sickn33/agentic-awesome-skills

AGENTS.md AGENTS.md file
sickn33/agentic-awesome-skills · AGENTS.md
git:20261029.00ee0d3 · audit A · 49,308 stars
llms.txt@apps/web-app/public llms.txt file
sickn33/agentic-awesome-skills · apps/web-app/public/llms.txt
git:20261102.1519f81 · audit A · 49,308 stars
00-andruia-consultant SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/00-andruia-consultant/SKILL.md · Usar al iniciar o mejorar un proyecto de IA: diagnostica código y restricciones, propone skills existentes y redacta…
git:20261014.c062f9f · audit A · 49,308 stars
007 SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/007/SKILL.md · Security audit, hardening, threat modeling (STRIDE/PASTA), Red/Blue Team, OWASP checks, code review, incident response…
git:20261024.6d4ea18 · audit A · 49,308 stars
10-andruia-skill-smith SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/10-andruia-skill-smith/SKILL.md · Usar para crear o mejorar una skill de Andru.ia: define entradas y resultados, redacta SKILL.md con ejemplos y límites…
git:20261014.c062f9f · audit A · 49,308 stars
20-andruia-niche-intelligence SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/20-andruia-niche-intelligence/SKILL.md · Usar tras definir el sector de un proyecto: prepara un dossier en español con contexto, normas aplicables, patrones UX…
git:20261014.c062f9f · audit A · 49,308 stars
2slides-ppt-generator SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/2slides-ppt-generator/SKILL.md · AI-powered presentation generation via the 2slides API — create slides from text, match a reference image style…
git:20261024.6d4ea18 · audit A · 49,308 stars
360-feedback-system SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/360-feedback-system/SKILL.md · 360 feedback register: reviewer, subject, review cycle, visibility, due date and score, as CSV, SQL, JSON Schema or…
git:20261024.6d4ea18 · audit A · 49,308 stars
3d-web-experience SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/3d-web-experience/SKILL.md · Use when building or debugging web 3D scenes, product configurators or portfolios with Three.js, React Three Fiber or…
git:20261014.c062f9f · audit A · 49,308 stars
a4a SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/a4a/SKILL.md · Connect your AI agent to the A4A end-to-end encrypted agent-to-agent messaging network via local MCP tools or Python…
git:20261024.6d4ea18 · audit A · 49,308 stars
aas-compose-stack SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/aas-compose-stack/SKILL.md · Preserve the coding agent's explicit AAS skill selection as a validated stack and optional evidence.
git:20261002.7bb0ab4 · audit A · 49,308 stars
aas-discover SKILL.md skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/aas-discover/SKILL.md · Discover AAS skills for an explicit task and compare their complete instructions without installing them.
git:20261002.7bb0ab4 · audit A · 49,308 stars

Every file in sickn33/agentic-awesome-skills

Other files named api-documentation-generator

api-documentation-generator SKILL.md skill
francostino/opencode-skills-collection · bundled-skills/api-documentation-generator/SKILL.md · Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and…
git:20260730.90257ed · audit A · 90 stars
api-documentation-generator SKILL.md skill
aicodedecode/awesome-muse-skills · skills-imported/api-documentation-generator/SKILL.md · Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and…
git:20260927.806f3e1 · audit A · 53 stars

Browse by kind, by grade A, or by owner.