How does it stay in sync with my code?

The skill analyzes your current codebase to generate documentation, making it easy to refresh and update your docs whenever your API structure changes.

Can it generate OpenAPI or Swagger specifications?

Yes, it can create standardized OpenAPI/Swagger YAML or JSON files that can be used with interactive documentation tools.

Which languages are supported for the request examples?

The skill typically generates examples for cURL, JavaScript (fetch/axios), and Python (requests), but it can be prompted for other languages as needed.

Does this skill support different API types?

Yes, it is designed to document REST, GraphQL, and WebSocket APIs by analyzing the specific structure and protocols used in your code.

Does it document error codes and authentication?

Yes, it identifies and documents status codes, error response formats, and authentication methods such as Bearer tokens and API keys.

API Documentation Generator

Name: API Documentation Generator
Author: claudiodearaujo

byclaudiodearaujo

API開発

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

概要

The API Documentation Generator skill automates the process of creating professional technical documentation by analyzing your API's source code. It extracts critical information such as HTTP methods, request/response schemas, authentication requirements, and error codes to produce structured guides for REST, GraphQL, and WebSocket APIs. By providing standardized templates and generating functional code snippets in languages like Python and JavaScript, it ensures that your API is easy to understand for both internal teams and external developers while maintaining consistency across your documentation suite.

主な機能

Automatic extraction of endpoints, methods, and parameters from source code
0 GitHub stars
Structured usage guidelines including rate limiting and pagination
Detailed documentation of authentication flows and error handling patterns
Creates OpenAPI/Swagger specifications and Postman collections
Generates multi-language code examples for cURL, JavaScript, and Python

ユースケース

Documenting a new REST or GraphQL API for external developer use
Updating outdated API documentation to reflect current codebase changes
Generating OpenAPI/Swagger specifications for interactive API testing

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

概要