api-documentation

Generate OpenAPI, AsyncAPI, or Protobuf specifications and Markdown or HTML documentation.

3|Updated Nov 18, 2025
One-click install
npx skills add https://github.com/pluginagentmarketplace/custom-plugin-technical-writer --skill api-documentation-pluginagentmarketplace
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/tree/main/skills/api-docs
Command: npx skills add https://github.com/pluginagentmarketplace/custom-plugin-technical-writer --skill api-documentation-pluginagentmarketplace

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and validation of comprehensive API documentation, ensuring clarity and adherence to standards for developers and consumers.

Core Features & Use Cases

  • API Specification Generation: Creates OpenAPI/Swagger, AsyncAPI, or Protobuf specifications from various inputs.
  • Documentation Formatting: Generates human-readable Markdown or HTML documentation from specifications.
  • Validation & Quality Checks: Validates generated specs and assesses documentation completeness.
  • Use Case: Automatically generate an OpenAPI 3.1 specification and corresponding Markdown documentation for a new REST API based on a provided list of endpoints and schemas.

Quick Start

Use the api-documentation skill to generate an OpenAPI specification for a REST API with the title 'My API' and version '1.0.0'.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I generate OpenAPI specifications from existing API endpoints?

To generate OpenAPI specifications, provide the API type, source information like endpoints or code, and desired output format. The Skill validates API structures and creates production-grade OpenAPI or Swagger specs from your input details.

Can I create AsyncAPI documentation for WebSocket APIs?

Yes, you can create AsyncAPI documentation for WebSocket APIs. The Skill generates AsyncAPI specifications and validates structures for event-driven APIs, requiring only the API type and source information to produce the output.

How do I convert Protobuf specifications into readable documentation?

You convert Protobuf specifications into readable documentation by providing the gRPC API details and selecting Markdown or HTML as the output format. The Skill generates human-readable docs directly from your Protobuf specifications.

Does the documentation generation process validate API authentication flows?

Yes, the documentation generation process validates API authentication flows. It assesses documentation completeness and validates generated specs, ensuring that authentication flows and error handling are properly documented for REST, GraphQL, or gRPC endpoints.

What is the best way to document REST and gRPC endpoints simultaneously?

The best way to document REST and gRPC endpoints simultaneously is to provide the endpoint details for both API types. The Skill processes the source information to generate specifications and validate structures across different protocols concurrently.