How does it handle API authentication documentation?

It analyzes your auth logic to document Bearer tokens, API keys, and OAuth flows, providing clear instructions for developers to get started.

Which API types are supported?

The skill supports REST, GraphQL, and WebSocket APIs, providing tailored documentation patterns for each architecture.

Can this skill generate OpenAPI specifications?

Yes, it can create standardized OpenAPI/Swagger YAML or JSON files based on your API's routes, methods, and data schemas.

Does it provide code examples in different languages?

Yes, it generates ready-to-use request snippets in cURL, JavaScript (Fetch/Axios), Python, and other common languages.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

API 开发

Generates comprehensive, developer-friendly API documentation from your codebase, including endpoints, parameters, and interactive examples.

关于

The API Documentation Generator is a specialized Claude Code skill designed to automate the creation of professional-grade API references directly from your source code. By analyzing routes, methods, and schemas, it produces detailed documentation for REST, GraphQL, and WebSocket APIs, complete with authentication guides, error handling patterns, and multi-language code snippets. It is ideal for developers looking to maintain up-to-date documentation, simplify onboarding, or export standardized OpenAPI and Postman specifications without the manual overhead of writing technical guides from scratch.

主要功能

Automatic endpoint discovery and analysis for REST, GraphQL, and WebSockets
Standardized formatting for authentication, rate limiting, and usage guidelines
Generation of multi-language code examples including cURL, JavaScript, and Python
Exportable OpenAPI/Swagger specifications and Postman collections
0 GitHub stars
Detailed error handling, status code, and validation rule documentation

使用场景

Creating interactive OpenAPI/Swagger specifications for external stakeholders
Generating professional documentation for a newly developed API
Updating existing API references to reflect recent codebase changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claudiodearaujo/sistema-de-narra-o-de-livro-front api-documentation-generator

For use in Claude.ai and ChatGPT

Download Skill

GitHub

关于