kata-api-design-doc

What problem does it solve?

It helps teams design consistent REST API endpoints and produce a human-readable, structured Markdown specification that complements the canonical OpenAPI artifact.

Core Features & Use Cases

• Endpoint design from feature inputs: Converts a bounded-context feature description into concrete resources, operations, methods, and path patterns.
• Conformance to REST and platform codexes: Aligns statuses, payload shapes, headers, pagination, sorting, idempotency, entity structures, error handling, and auth expectations.
• On-demand Markdown documentation output: Generates a Markdown document saved under docs/{context}/oas/ with endpoint tables, global headers, known errors, and examples.

Quick Start

Ask the AI to generate the RESTful API Markdown documentation for your feature by providing the bounded context name, the feature description, and the base path you want to use.