Is this skill suitable for internal or public APIs?

It is designed for both. The professional formatting is suitable for public-facing developer portals while maintaining the detail required for internal team handoffs.

Can I document both requests and responses?

Yes, it provides detailed tables for path parameters, query parameters, request bodies, and success/error response structures.

How does this skill help with API versioning?

It includes a dedicated Procedure: Changelog section that helps track breaking changes, deprecations, and new features across different API versions.

What programming languages are supported for code examples?

The skill includes templates for common languages including cURL, JavaScript (Fetch), and Python (Requests), ensuring wide developer accessibility.

API Documentation Professional

Name: API Documentation Professional
Author: majiayu000

bymajiayu000

•

学习与文档

Generates comprehensive, standardized API references including endpoint details, authentication guides, and multi-language code examples.

This skill provides a structured framework for creating high-quality API documentation within the Claude Code environment. It streamlines the process of documenting services by providing standardized templates for endpoints, request/response objects, error catalogs, and versioning. By following proven industry patterns, it ensures your API documentation is consistent, clear, and developer-friendly, making it an essential tool for backend engineers and technical writers who need to maintain accurate references for complex systems.

主要功能

01Automated multi-language code snippets including cURL, JavaScript, and Python

02Comprehensive authentication and base URL overview sections

0394 GitHub stars

04Integrated API changelog management for version tracking

05Structured error catalogs with status codes and resolution steps

06Standardized templates for HTTP endpoints and resource schemas

使用场景

01Generating a complete, professional API reference for a new backend service

02Creating clear error handling guides and developer troubleshooting resources

03Standardizing inconsistent internal documentation to follow industry best practices

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add majiayu000/claude-skill-registry skills

For use in Claude.ai and ChatGPT

Download Skill