skills.rest
sethdford
sethdfordCOMMUNITY
Explore all skills by this author →
𝕏@sethdFordGitHub

API Documentation Generator

Generate Confluence-ready API documentation from OpenAPI specs or code.

2|1|Updated Oct 17, 2025
Search Tags:#documentation#api#openapi#rest#swagger#confluence
One-click install
npx skills add https://github.com/sethdford/claude-plugins --skill api-documentation-generator-sethdford
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: API Documentation Generator
Source: https://github.com/sethdford/claude-plugins/tree/main/confluence-plugin/.claude-plugin/skills/api-documentation
Command: npx skills add https://github.com/sethdford/claude-plugins --skill api-documentation-generator-sethdford

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps generate structured API documentation in Confluence from code, OpenAPI specs, or endpoints. It ensures consistent, developer-friendly references that are easy to navigate for both engineers and product teams.

Core Features & Use Cases

  • OpenAPI/Swagger support: Convert specs to comprehensive API pages.
  • Endpoint-level detail: Each endpoint includes description, parameters, responses, and examples.
  • Multi-format outputs: Generates cURL examples, code samples, and error mappings.
  • Use Case: Document a new REST API surface or convert an OpenAPI spec to a Confluence-ready reference.

Quick Start

Provide your OpenAPI spec or codebase, and ask to generate a complete Confluence API documentation page with sections for authentication, rate limits, and versioning.

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

API documentation generation converts OpenAPI specs into structured Confluence pages with endpoint details, parameters, request/response examples, authentication, rate limits, and error codes automatically formatted and ready to publish.

Can I create REST API documentation directly from my codebase?▼

Yes, REST API documentation can be generated from code or OpenAPI specs. The Skill produces comprehensive reference pages with endpoint headers, parameter tables, cURL examples, code samples, and version history in Confluence-ready format.

What's included in the generated API documentation pages?▼

Generated pages include endpoint descriptions, parameter tables with types and requirements, request and response examples, authentication details, rate limit specifications, error code mappings, and changelog sections for version tracking.

Does this work with both REST and GraphQL APIs?▼

The Skill applies to REST and GraphQL APIs, converting OpenAPI specs or code into comprehensive documentation with structured sections for endpoints, parameters, responses, and examples tailored to each API type.

How do I ensure consistent API documentation across teams?▼

Automated generation from OpenAPI specs or code enforces a complete template with standardized sections for endpoints, parameters, authentication, and errors, ensuring consistent, developer-friendly documentation across all team APIs.

Can I convert an existing OpenAPI spec to Confluence?▼

OpenAPI-to-Confluence conversion is supported. The Skill transforms specs into Confluence-ready documentation pages with all endpoint details, parameter mappings, examples, and error references structured in a complete template.

Related Skills

Explore More Software Engineering Skills→
mikopbxmikopbx
569

openapi-analyzer

Extract and analyze OpenAPI 3.1.0 specifications to validate endpoints and generate tests.

Official
Advanced
atlassianatlassian
949

generate-status-report

Generate status reports from Jira issues and publish them to Confluence.

Official
Intermediate
patricio0312revpatricio0312rev
5

openapi-generator

Generate OpenAPI 3.0/3.1 specifications from Express, Next.js, Fastify, Hono, and NestJS routes.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced