Does this skill support both REST and GraphQL?

Yes, it includes specialized patterns for documenting both RESTful endpoints and GraphQL queries, mutations, and types.

Does it provide documentation for authentication?

Yes, it includes templates and best practices for documenting common auth methods like API Keys, JWT Bearer Tokens, and OAuth 2.0.

How does it identify my API endpoints?

The skill analyzes your codebase, specifically looking at routes, controllers, and data models, to discover and document the structure of your API.

Can it generate code examples for my API?

Absolutely. It creates copy-pasteable examples in cURL, Python (requests), and JavaScript (fetch) to help developers get started quickly.

Can I use this to generate Swagger or OpenAPI files?

While it primarily generates human-readable Markdown, it can be used to extract the necessary information to build Swagger/OpenAPI specifications.

API Documentation Generator

Name: API Documentation Generator
Author: a-ariff

bya-ariff

学习与文档

Generates comprehensive, developer-friendly API documentation for REST and GraphQL services directly from your source code.

关于

The API Documentation Generator is a specialized skill for Claude Code designed to transform complex back-end codebases into clear, actionable documentation. It automates the discovery of endpoints, extraction of data models, and creation of working code examples in multiple languages including JavaScript, Python, and cURL. By following a standardized documentation philosophy, it ensures that your APIs include clear authentication guides, detailed error handling, and logical pagination structures, making it an essential tool for maintaining high-quality developer portals, README files, and internal technical documentation.

主要功能

Automatic endpoint discovery and analysis for REST and GraphQL APIs
Comprehensive documentation for API Keys, JWT, and OAuth 2.0 authentication
0 GitHub stars
Standardized markdown output with request/response schema tables
Detailed error code mapping and validation rule extraction
Multi-language code snippet generation for cURL, Python, and JavaScript

使用场景

Updating outdated documentation automatically after a major code refactor
Creating a professional API README for a new microservice or project
Generating detailed data models and schema definitions from source code

关于

主要功能

Automatic endpoint discovery and analysis for REST and GraphQL APIs
Comprehensive documentation for API Keys, JWT, and OAuth 2.0 authentication
0 GitHub stars
Standardized markdown output with request/response schema tables
Detailed error code mapping and validation rule extraction
Multi-language code snippet generation for cURL, Python, and JavaScript

使用场景

Updating outdated documentation automatically after a major code refactor
Creating a professional API README for a new microservice or project
Generating detailed data models and schema definitions from source code