Will it document error codes and edge cases?

Yes, it extracts and maps all possible error codes, message formats, and provides troubleshooting steps for common error scenarios.

Does it provide code examples for front-end developers?

Absolutely. The skill generates ready-to-use code snippets in various languages including JavaScript/TypeScript (fetch/axios) and Python (requests).

Can it generate interactive specifications like Swagger?

Yes, it can generate OpenAPI/Swagger YAML/JSON files and Postman collections, allowing for interactive testing and exploration.

How does it handle authentication details?

It analyzes your code to document security requirements such as Bearer tokens, API keys, and specific login/refresh token flows.

What API types does this skill support?

The API Documentation Generator supports REST, GraphQL, and WebSocket APIs, making it versatile for most modern backend architectures.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

Desarrollo de API

Generates comprehensive, developer-friendly API documentation directly from your codebase, including endpoints, authentication, and usage examples.

Acerca de

The API Documentation Generator skill streamlines the process of creating professional-grade documentation by automatically analyzing your code to extract endpoints, request/response schemas, and authentication requirements. It supports REST, GraphQL, and WebSocket APIs, producing everything from detailed endpoint specifications and multi-language code snippets to interactive OpenAPI/Swagger files and Postman collections. This skill is ideal for developers looking to maintain accurate documentation that stays in sync with their code, reducing the manual effort required for developer onboarding and external API publishing.

Características Principales

Automatic discovery of endpoints, routes, and HTTP methods
Generation of multi-language code examples (cURL, JS, Python)
Detailed error handling mapping and troubleshooting guides
Schema extraction for request bodies and response formats
0 GitHub stars
Exportable OpenAPI/Swagger and Postman collection specifications

Casos de Uso

Creating interactive API specifications for external developers and stakeholders
Generating professional documentation for a newly built REST or GraphQL API
Synchronizing outdated API documentation with current codebase changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claudiodearaujo/izacenter api-documentation-generator

For use in Claude.ai and ChatGPT

Download Skill

GitHub