Which API types does this skill support?

It supports REST, GraphQL, and WebSocket APIs, providing specialized documentation patterns and schema definitions for each.

Does it include code snippets for developers?

Absolutely. It generates ready-to-use request examples in cURL, JavaScript (fetch/axios), and Python by default.

Can it document error responses?

Yes, the skill analyzes your code to document status codes, error message formats, and provides troubleshooting steps for common failure scenarios.

Can it generate interactive specifications?

Yes, the skill can generate OpenAPI/Swagger YAML/JSON files and Postman collections for easier testing and integration.

How does it handle authentication details?

It documents various authentication methods including Bearer tokens, API keys, and OAuth2 flows, complete with setup and usage instructions.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

•

API Development

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

The API Documentation Generator is a specialized Claude Code skill designed to automate the creation of professional technical documentation by analyzing your codebase. It extracts critical details such as endpoint structures, HTTP methods, request/response schemas, and authentication requirements for REST, GraphQL, and WebSocket APIs. By providing standardized templates and multi-language code snippets, this skill helps development teams maintain accurate documentation, accelerate developer onboarding, and ensure that API specifications like OpenAPI/Swagger stay perfectly in sync with the underlying logic.

Key Features

01Generation of OpenAPI/Swagger and Postman collection specifications.

02Automated extraction of endpoints, methods, and parameters from code.

031 GitHub stars

04Multi-language request examples including cURL, JavaScript, and Python.

05Support for REST, GraphQL, and WebSocket documentation patterns.

06Detailed error handling, status code, and authentication documentation.

Use Cases

01Updating outdated API references to match current codebase logic.

02Creating interactive specifications and Postman collections for external developers.

03Generating professional documentation for a newly developed API.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill

Key Features

01Generation of OpenAPI/Swagger and Postman collection specifications.

02Automated extraction of endpoints, methods, and parameters from code.

031 GitHub stars

04Multi-language request examples including cURL, JavaScript, and Python.

05Support for REST, GraphQL, and WebSocket documentation patterns.

06Detailed error handling, status code, and authentication documentation.

Use Cases

01Updating outdated API references to match current codebase logic.

02Creating interactive specifications and Postman collections for external developers.

03Generating professional documentation for a newly developed API.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill