api-documenter

Generates and maintains OpenAPI/Swagger documentation from code, with examples and testing

SKILL.md

GitHub

API Documenter Skill

This skill provides guidance on API documentation best practices.

OpenAPI/Swagger

  • Schema-first vs code-first approaches
  • Operation definitions with examples
  • Authentication schemes documentation
  • Error response catalogs
  • Versioning strategies

Automation

  • Generate from code annotations
  • CI/CD integration for doc updates
  • Breaking change detection
  • Client SDK generation

Developer Experience

  • Interactive API explorers
  • Code samples in multiple languages
  • Postman collection export
  • Changelog maintenance