api-documentation_skill

Overview

This skill generates comprehensive API documentation for Confluence from code, OpenAPI/Swagger specs, or live endpoints. It produces structured pages that include endpoint descriptions, parameters, request/response examples, error codes, authentication, rate limiting, and changelogs. The output is organized for Confluence with code samples and tables ready for publishing. Use it to accelerate accurate, consistent API references and guides.

How this skill works

The skill analyzes source inputs (OpenAPI spec, server code, or endpoint metadata) to extract API metadata: methods, paths, parameters, request/response schemas, status codes, and security requirements. It builds a standard Confluence page structure per endpoint and resource, generating multi-language request examples, response samples, error tables, and pagination/rate-limit sections. When requested, it converts the result into Confluence-friendly format (ADF or markdown) and can include navigation, changelog, and versioning notes.

When to use it

• Document new or updated API endpoints after implementation
• Convert OpenAPI/Swagger specs into Confluence pages
• Create or update API reference pages for REST or GraphQL APIs
• Produce request and response examples in multiple languages (cURL, JS, Python)
• Document authentication, rate limiting, pagination, and error handling

Best practices

• Include clear endpoint summaries and permission requirements for each route
• Provide complete, runnable examples that include authentication headers
• Document all possible error responses with codes and resolution steps
• Keep versioning and changelogs in the docs and mark deprecated endpoints
• Use consistent naming and parameter conventions across resources

Example use cases

• Generate a full API space for Confluence from an OpenAPI file (title, base URL, auth, endpoints)
• Scan Express.js or Fastify routes to auto-generate endpoint pages with examples and responses
• Convert a Swagger UI export into Confluence-format reference pages with tables and code blocks
• Create a quick-start guide section with authentication flows (API Key, OAuth2) and working curl examples
• Add rate limiting and pagination documentation to existing endpoint pages