What kind of APIs does this skill support?

It is primarily designed for RESTful APIs, providing structures for HTTP methods, paths, query parameters, and JSON request/response bodies.

Why does it require loading other skills first?

This skill acts as a high-level orchestrator that requires voice-and-tone and structure skills to ensure the output remains professional and consistent with your project's overall documentation style.

Does it handle error codes?

Yes, it includes a mandatory requirement to document all error codes with their status, description, and suggested resolution guidance.

Can it generate examples automatically?

Yes, the skill emphasizes creating realistic, working examples with actual UUIDs and timestamps rather than placeholder text like 'foo' or 'bar'.

API Reference Documentation

Name: API Reference Documentation
Author: luanrodrigues

byluanrodrigues

•

API Development

Generates standardized, production-grade API reference documentation including endpoint schemas, error codes, and realistic request/response examples.

This skill provides a structured framework for documenting RESTful APIs within Claude Code, ensuring consistency across endpoint descriptions, parameters, and request/response bodies. It enforces high-quality documentation standards by requiring realistic data examples and comprehensive error resolution tables, making it an essential tool for developers and technical writers who need to create developer-friendly, accurate, and professional API references.

Key Features

01Standardized endpoint documentation structure with HTTP methods and paths

02Detailed field description patterns for request and response schemas

03Support for pagination and API versioning documentation

04Comprehensive error documentation including status codes and resolutions

052 GitHub stars

06Realistic request/response JSON example generation

Use Cases

01Documenting new REST API endpoints during the development lifecycle

02Creating external-facing developer portals with consistent field descriptions

03Standardizing undocumented legacy API routes for better team collaboration

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add luanrodrigues/ia-frmwrk writing-api-docs

For use in Claude.ai and ChatGPT

Key Features

01Standardized endpoint documentation structure with HTTP methods and paths

02Detailed field description patterns for request and response schemas

03Support for pagination and API versioning documentation

04Comprehensive error documentation including status codes and resolutions

052 GitHub stars

06Realistic request/response JSON example generation

Use Cases

01Documenting new REST API endpoints during the development lifecycle

02Creating external-facing developer portals with consistent field descriptions

03Standardizing undocumented legacy API routes for better team collaboration

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add luanrodrigues/ia-frmwrk writing-api-docs

For use in Claude.ai and ChatGPT