api-documentation-generator

Generate REST, GraphQL, and WebSocket API documentation with code examples.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/javierhbr/agnostic-agent-loop --skill api-documentation-generator-javierhbr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/javierhbr/agnostic-agent-loop/tree/main/internal/skills/packs/api-docs
Command: npx skills add https://github.com/javierhbr/agnostic-agent-loop --skill api-documentation-generator-javierhbr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of detailed, production-ready documentation for any API, ensuring clarity and ease of use for developers.

Core Features & Use Cases

  • Automated Generation: Scans code to produce per-endpoint documentation, including request/response schemas, authentication details, and error codes.
  • Multi-Format Output: Delivers documentation in various formats like OpenAPI/Swagger YAML and Postman collections.
  • Use Case: You've just launched a new REST API and need to provide clear documentation for your partners. This Skill will generate all necessary reference pages, code examples, and an OpenAPI spec.

Quick Start

Use the api-documentation-generator skill to generate documentation for your API.

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 my existing codebase?

To generate API documentation, this Skill analyzes your codebase for routes, methods, parameters, and response shapes to produce detailed per-endpoint documentation, code examples, and error handling guides automatically.

Can I create OpenAPI and Swagger specifications for REST APIs automatically?

Yes, you can create OpenAPI and Swagger specifications automatically. The Skill delivers documentation in standard formats like OpenAPI/Swagger YAML and Postman collections by analyzing your REST API codebase.

Does this approach work for GraphQL and WebSocket APIs or just REST?

This approach works for GraphQL and WebSocket APIs as well as REST. The Skill generates comprehensive API documentation across all three protocols by extracting schemas and methods from your codebase.

What is the best way to document API authentication details and error codes?

The best way to document API authentication details and error codes is through automated generation. The Skill scans your code to produce per-endpoint documentation including authentication details and error handling guides.

How do I get code examples in multiple languages for my API endpoints?

To get code examples in multiple languages for your API endpoints, the Skill analyzes your codebase and automatically generates corresponding examples alongside your OpenAPI or Postman collection outputs.