Agent skill · writing content · secondsky
api-reference-documentation
Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.
Why this skill is useful
Provides detailed OpenAPI specification templates and best practices for documenting REST APIs that the AI wouldn't reliably generate on its own.
What it needs
About 1k tokens when loaded. Last updated 2026-08-06. 204 stars on the source repository.
What this skill does
API Reference Documentation Create comprehensive API documentation for developer integration. OpenAPI 3.0 Specification Documentation Checklist [ ] All endpoints documented with examples [ ] Authentication methods explained [ ] Error responses specified [ ] Rate limits documented [ ] Pagination explained [ ] Webhooks documented (if applicable) [ ] SDK examples in multiple languages Best Practices Use OpenAPI 3.0+ specification Include request/response examples Document all parameters and headers Provide authentication examples Enable interactive API exploration Maintain version documentation Include migration guides for breaking changes Tools Swagger Editor / Swagger UI Redoc Postman Documentation Stoplight
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills secondsky/api-reference-documentation