api-documentation

Generate API documentation for REST/HTTP, gRPC, GraphQL, and RPC APIs.

4|2|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/wojons/skills --skill api-documentation-wojons
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/wojons/skills/tree/main/skills/api-documentation
Command: npx skills add https://github.com/wojons/skills --skill api-documentation-wojons

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive and interactive API documentation across multiple protocols, ensuring accuracy and usability for developers and consumers.

Core Features & Use Cases

  • Multi-protocol Support: Generates documentation for REST/HTTP, gRPC, GraphQL, and RPC APIs.
  • Automated Generation: Extracts documentation from code, schemas, and definitions.
  • Use Case: You need to document a new microservice that exposes a REST API and a gRPC interface; this skill can generate a unified documentation portal for both.

Quick Start

Use the api-documentation skill to generate OpenAPI documentation from the source files in the 'src/' directory.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I generate API documentation for both REST and gRPC interfaces?

You can generate unified API documentation for REST and gRPC by extracting schemas and definitions directly from your source code. This approach automates the creation of a comprehensive developer portal for both protocols.

What is code-first API documentation extraction?

Code-first API documentation extraction is the process of automatically generating documentation artifacts directly from your implementation's source files and schemas. This ensures your documentation accurately reflects the current API implementation without manual updates.

Can I generate OpenAPI documentation from my existing source files?

Yes, you can generate OpenAPI documentation from existing source files by running an automated extraction process on your 'src/' directory. This parses your code definitions to produce the required OpenAPI specifications and interactive examples.

Does automated API documentation support GraphQL and RPC APIs?

Automated API documentation generation supports GraphQL and RPC APIs alongside REST and gRPC. It parses your schemas to generate comprehensive documentation tailored to each specific protocol's structure.

How do I check consistency between my API implementation and documentation?

You can check consistency between your API implementation and documentation by using an automated generation tool that compares source code definitions against existing documentation artifacts to identify discrepancies.