Does it provide code examples in multiple languages?

Absolutely. It creates snippets for cURL, JavaScript (Fetch/Axios), and Python (Requests) by default.

What types of APIs can this skill document?

It supports REST, GraphQL, and WebSocket APIs, covering a wide range of modern backend architectures.

Can it generate interactive specifications?

Yes, the skill can generate OpenAPI (Swagger) specifications and Postman collections for interactive testing.

How does it handle authentication details?

It identifies and documents various auth methods including Bearer tokens, API keys, and OAuth2 flows.

Will it keep my documentation in sync with my code?

By analyzing the codebase directly, it ensures that your documentation reflects the actual implementation, reducing the risk of drift.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

•

API開発

Generates professional, developer-friendly API documentation directly from codebase structure and comments.

概要

This skill streamlines the creation of comprehensive API documentation by analyzing source code to extract endpoints, request/response schemas, authentication protocols, and error handling patterns. It automatically produces standardized documentation including cURL examples, multi-language code snippets, and OpenAPI/Swagger specifications, making it essential for onboarding developers, maintaining up-to-date references, and improving the developer experience for internal or external APIs.

主な機能

Automatic endpoint analysis for REST, GraphQL, and WebSockets
Generation of request/response schemas and status code references
OpenAPI/Swagger and Postman collection generation
1 GitHub stars
Comprehensive authentication and error-handling documentation
Multi-language code examples including cURL, JavaScript, and Python

ユースケース

Documenting a newly built REST or GraphQL API for external consumption
Syncing outdated documentation with the current state of a legacy codebase
Standardizing internal API documentation across multiple microservices

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

GitHub

概要