Can it generate OpenAPI/Swagger files?

Yes, it can generate YAML or JSON OpenAPI specifications as well as Postman collections to make your API immediately testable.

Does it include code examples for developers?

Yes, it automatically creates working code snippets in multiple languages including JavaScript (Fetch/Axios), Python (Requests), and cURL.

What API types does this skill support?

It supports REST, GraphQL, and WebSocket APIs, providing specific documentation patterns and best practices for each architectural style.

How does it handle API security documentation?

It analyzes your authentication logic to document Bearer tokens, API keys, OAuth flows, and other security requirements clearly for end users.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

•

API Development

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

The API Documentation Generator skill automates the creation of professional-grade documentation for REST, GraphQL, and WebSocket APIs. By analyzing your codebase, it extracts endpoint structures, authentication requirements, and data schemas to produce clear guides featuring cURL commands, multi-language code snippets, and error-handling protocols. It is an essential tool for onboarding developers, maintaining up-to-date specifications like OpenAPI/Swagger, and ensuring that your API's external and internal documentation never falls out of sync with the underlying implementation.

Key Features

01OpenAPI/Swagger and Postman collection exports

021 GitHub stars

03Multi-language code example generation (cURL, JS, Python)

04Automated endpoint discovery and structural analysis

05Comprehensive error handling and status code documentation

06Authentication and rate-limiting guideline creation

Use Cases

01Updating outdated documentation after significant API refactors

02Creating developer onboarding guides with clear usage patterns and examples

03Generating interactive Swagger UI specifications for new REST services

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

01OpenAPI/Swagger and Postman collection exports

021 GitHub stars

03Multi-language code example generation (cURL, JS, Python)

04Automated endpoint discovery and structural analysis

05Comprehensive error handling and status code documentation

06Authentication and rate-limiting guideline creation

Use Cases

01Updating outdated documentation after significant API refactors

02Creating developer onboarding guides with clear usage patterns and examples

03Generating interactive Swagger UI specifications for new REST services

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