api-documentation

Create API documentation from OpenAPI/Swagger specs with runnable examples.

364|53|Updated May 9, 2026

Search Tags:#versioning #authentication #openapi #swagger #api reference #postman #sdk generation

Ready to run

npx skills add https://github.com/cosmicstack-labs/mercury-agent-skills --skill api-documentation-cosmicstack-labs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/cosmicstack-labs/mercury-agent-skills/tree/main/categories/development/api-documentation
Command: npx skills add https://github.com/cosmicstack-labs/mercury-agent-skills --skill api-documentation-cosmicstack-labs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you prevent API documentation drift and developer confusion by turning OpenAPI/Swagger specs into complete, runnable, and versioned documentation assets.

Core Features & Use Cases

Spec-first documentation: Keeps the OpenAPI/Swagger specification as the source of truth for docs, examples, and derived outputs.
Developer-experience coverage: Documents authentication, errors, rate limiting, pagination, and common workflows—not just endpoints.
Runnable artifacts: Ensures each endpoint includes complete request/response examples and optional Postman collection structure to validate behavior.
Versioning and maturity guidance: Provides a maturity model plus strategies for deprecation timelines and migration guides so clients can adapt safely.

Quick Start

Ask the AI to produce an OpenAPI 3.x spec outline (including security, error schemas, rate limit headers, and per-endpoint runnable examples) and a Postman collection skeleton for your API.

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 from an OpenAPI or Swagger spec?▼

Generate API documentation from OpenAPI or Swagger specs by using a spec-first approach that keeps the specification as the source of truth for complete, runnable, and versioned documentation assets. This prevents documentation drift and developer confusion.

What should API documentation cover beyond basic endpoint definitions?▼

API documentation should cover developer experience including authentication, standardized error response schemas, rate limiting, pagination, and common workflows, ensuring complete request and response examples for every endpoint rather than just listing endpoints.

Can I create a Postman collection from my OpenAPI specification?▼

Yes, you can create a Postman collection skeleton from your OpenAPI specification to validate behavior. This produces runnable artifacts ensuring each endpoint includes complete request and response examples for Postman-based validation.

How do I document API versioning and deprecation timelines for clients?▼

Document API versioning and deprecation timelines by providing a maturity model alongside strategies for deprecation timelines and migration guides. This ensures clients can adapt safely to changes in your REST API.

Does this approach work for preparing client SDK generation from API specs?▼

Yes, this approach works for client SDK generation preparation by applying spec-first authoring to OpenAPI specifications. It ensures complete request and response examples, standardized error schemas, and authentication coverage required for reliable SDK generation.