kata-api-design-oas

What problem does it solve?

It helps you design RESTful endpoints and generate a production-ready OpenAPI 3.x specification without missing required headers, error formats, pagination rules, or idempotency requirements.

Core Features & Use Cases

• REST endpoint design: Maps feature resources to HTTP methods, paths, request/response payloads, and status codes.
• Spec-first OAS generation: Produces an OpenAPI 3.x YAML with operations ordered per project conventions and schemas aligned to entity and payload standards.
• Consistency safeguards: Enforces standardized error structure, idempotency for mutations, and pagination/sorting documentation for list endpoints.
• Use case: When launching a new Guardia platform feature, quickly create the canonical docs/{context}/oas/openapi.yaml contract that matches Lexis/Codex conventions.

Quick Start

Ask the AI to generate the OpenAPI 3.x contract for your feature’s REST API, including base path, resources, authentication style, and pagination/sorting needs.