api-documentation-generator

Generate API documentation with endpoints, schemas, and authentication details.

1|Updated Feb 6, 2026

Search Tags:#developer tools #documentation #api #openapi #code documentation #generator

Ready to run

npx skills add https://github.com/Adam-Guerin/Asmblr --skill api-documentation-generator-adam-guerin

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/Adam-Guerin/Asmblr/tree/main/skills/api-documentation-generator
Command: npx skills add https://github.com/Adam-Guerin/Asmblr --skill api-documentation-generator-adam-guerin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of comprehensive, developer-friendly API documentation, ensuring clarity and consistency for your endpoints, parameters, and examples.

Core Features & Use Cases

Automated Documentation Generation: Creates detailed documentation for REST, GraphQL, and WebSocket APIs.
Endpoint & Parameter Details: Includes HTTP methods, URL paths, request/response schemas, and authentication requirements.
Code Examples: Provides cURL, JavaScript, and Python examples for easy integration.
Use Case: Automatically generate professional documentation for a new microservice API, including all endpoints, request/response formats, and authentication details, making it easy for other developers to integrate.

Quick Start

Use the api-documentation-generator skill to create documentation for the provided API codebase.

Frequently Asked Questions about api-documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate API documentation from source code automatically?▼

To generate API documentation from source code automatically, provide your codebase to the generator; it analyzes endpoints, parameters, request and response schemas, and authentication details to produce developer-friendly guides and OpenAPI specifications.

Can I create OpenAPI specifications for both REST and GraphQL APIs?▼

Yes, you can create OpenAPI specifications for both REST and GraphQL APIs. The generator supports REST, GraphQL, and WebSocket APIs, detailing HTTP methods, URL paths, and schemas to produce comprehensive developer documentation.

What is the best way to document API authentication and usage examples?▼

The best way to document API authentication and usage examples is to use an automated generator that extracts authentication requirements from code and provides cURL, JavaScript, and Python examples for easy developer integration.

Does the API documentation generator work with WebSocket APIs?▼

Yes, the API documentation generator works with WebSocket APIs. It supports REST, GraphQL, and WebSocket protocols, detailing endpoints, parameters, and request and response schemas to create comprehensive developer-friendly guides.

How do I produce developer-friendly API guides for a new microservice?▼

To produce developer-friendly API guides for a new microservice, process your microservice codebase with the generator to automatically extract all endpoints, request and response formats, and authentication details for integration-ready documentation.

What code examples are included when generating API docs?▼

When generating API docs, the tool includes cURL, JavaScript, and Python code examples. These examples accompany the endpoint details, parameters, request and response schemas, and authentication requirements extracted from your source code.