api-documentation-generator

Generate API documentation from code for REST, GraphQL, and WebSocket APIs.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/BoraPerusic/agents --skill api-documentation-generator-boraperusic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/BoraPerusic/agents/tree/main/skills/to%20try/api-documentation-generator
Command: npx skills add https://github.com/BoraPerusic/agents --skill api-documentation-generator-boraperusic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically convert codebases into comprehensive API documentation, reducing manual writing and keeping docs in sync with source.

Core Features & Use Cases

  • Generate endpoint descriptions, request/response schemas, authentication notes, error handling, and usage guidelines from your code.
  • Produce OpenAPI/Swagger specs and Postman collections to facilitate testing and integration.
  • Ideal for documenting REST, GraphQL, and WebSocket APIs, onboarding new developers, and maintaining up-to-date API references.

Quick Start

Document my codebase by generating comprehensive API documentation including endpoints, parameters, examples, and best practices.

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 directly from my codebase?

You can generate API documentation by processing your source code to extract endpoint details, request and response schemas, authentication notes, and error handling guidelines automatically, reducing manual writing and keeping docs in sync with source.

Can I create OpenAPI and Swagger specifications from existing code?

Yes, you can produce OpenAPI and Swagger specifications from your codebase to facilitate testing and integration, alongside generating standard endpoint descriptions and usage guidelines for developers.

Does this API documentation generator work with GraphQL and WebSocket APIs?

The API documentation generator applies to REST, GraphQL, and WebSocket APIs, supporting documenting new APIs, updating existing documentation, and onboarding developers across these protocols.

What is the best way to keep API documentation updated when source code changes?

The best way to keep API documentation updated is to automatically convert your codebase into comprehensive references, ensuring endpoint details and schemas stay in sync with the source code without manual writing.

Can I export Postman collections for testing from my generated API docs?

Yes, you can produce Postman collections from your codebase to facilitate testing and integration, alongside generating OpenAPI specifications and comprehensive usage guidelines for your APIs.