Generate API documentation and specs

api-documentation-writerskillsetup L2172
OneWave-AI/claude-skills
What it does

Generate API documentation with request/response examples and schemas

Best for

Quickly generating maintainable API docs from code when you want single-source-of-truth specs that sync with implementation

Inputs
  • · API endpoint definitions
  • · request/response payloads
  • · error codes
Outputs
  • · OpenAPI/Swagger spec
  • · Markdown documentation
  • · code examples (cURL, JS, Python)
Requires
  • · OpenAPI spec generator
Preconditions

API endpoints clearly defined; payload examples available

Failure modes

Missing error documentation; ambiguous parameter types; example payloads outdated

Trust signals
  • · multi-language code examples
  • · error code reference
  • · schema validation included