How does it handle error documentation?

It identifies error handling patterns in your code to document all possible status codes, error response formats, and troubleshooting steps for developers.

What API types does this skill support?

This skill is designed to handle REST APIs, GraphQL APIs, and WebSocket APIs, providing specific documentation patterns for each architecture.

Can it generate interactive documentation?

Yes, it can generate OpenAPI/Swagger YAML/JSON files and Postman collections to provide interactive testing environments for your users.

Does it automatically detect authentication methods?

Yes, it analyzes your codebase to identify and document authentication requirements such as Bearer tokens, API keys, and OAuth flows.

What languages are included in the generated code examples?

The skill typically provides examples in cURL, JavaScript (Fetch/Axios), and Python (Requests), but can be prompted to include other languages as needed.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

API 开发

Generates comprehensive, professional-grade API documentation directly from your codebase including endpoints, request/response examples, and error handling.

关于

The API Documentation Generator skill automates the creation of high-quality documentation for REST, GraphQL, and WebSocket services. By analyzing your codebase, it extracts routes, authentication requirements, and data schemas to produce developer-friendly guides. It creates complete documentation suites featuring multi-language code snippets, interactive OpenAPI/Swagger specifications, and Postman collections, making it an essential tool for onboarding developers and maintaining a synchronized, accurate reference for your API's capabilities.

主要功能

Multi-language code examples (cURL, JavaScript, Python)
Detailed error code and troubleshooting guide creation
OpenAPI/Swagger and Postman collection generation
Comprehensive request/response schema documentation
0 GitHub stars
Automated endpoint and route structure extraction

使用场景

Documenting a new API from scratch during the development phase
Generating external-facing API specifications for third-party integrations
Updating legacy documentation 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

关于