api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

1|Updated Feb 5, 2026
One-click install
npx skills add https://github.com/ChenYCL/claude-skills-collection --skill api-docs-chenycl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/ChenYCL/claude-skills-collection/tree/main/api-docs
Command: npx skills add https://github.com/ChenYCL/claude-skills-collection --skill api-docs-chenycl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation of professional API documentation, ensuring clarity and consistency for developers.

Core Features & Use Cases

  • Endpoint Documentation: Generates detailed descriptions for API endpoints, including request/response formats and parameters.
  • OpenAPI/Swagger Specs: Creates industry-standard OpenAPI 3.0 specifications in YAML or JSON.
  • Use Case: You've just built a new REST API and need to provide clear documentation for your team and external consumers. Use this Skill to generate Markdown and an OpenAPI spec from your endpoint definitions.

Quick Start

Use the api-docs skill to generate documentation for the provided API specification.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate API documentation from an OpenAPI specification?

To generate API documentation, provide your OpenAPI specification or endpoint definitions. The Skill processes these inputs to produce comprehensive reference guides and industry-standard OpenAPI 3.0 specifications in YAML or JSON.

Can I create Swagger specs from existing code or endpoint descriptions?

Yes, you can create Swagger specs by supplying your code, endpoint definitions, or descriptions. The Skill analyzes these inputs to generate valid OpenAPI 3.0 specifications in either YAML or JSON format.

Does this tool support documenting GraphQL schemas and RPC endpoints, or just REST APIs?

This tool supports documenting REST APIs, GraphQL schemas, and RPC endpoints. It generates detailed descriptions for endpoints, including request and response formats and parameters.

What's the best way to write SDK documentation for my development team?

The best way to write SDK documentation is to input your API definitions or specifications. The Skill automatically generates professional Markdown reference guides and SDK documentation, ensuring clarity and consistency for developers.

Do I need to manually format request and response parameters for my API reference guides?

No, you do not need to manually format request and response parameters. The Skill automatically extracts and documents these details, generating comprehensive API reference guides from your provided descriptions or OpenAPI specs.