api-designer

To generate an OpenAPI 3.1 specification from a DMML domain model, run the API Designer on your DMML document. It automatically maps bounded contexts to tags, commands to POST endpoints, and read models to GET endpoints.

DMML bounded contexts map to OpenAPI tags and boundary endpoints, while aggregates define the structure. Commands are mapped to POST endpoints and read models are mapped to GET endpoints to expose domain capabilities as REST operations.

Generating OpenAPI from DMML automatically documents invariants and preconditions as standard error responses. It also generates schemas for value objects, entities, and domain events, wiring them directly to the relevant operations.

For draft elements in an OpenAPI specification derived from domain-driven design, the conversion process supports them via an x-draft extension in operations when appropriate, ensuring incomplete domain capabilities are properly flagged.

Yes, you need pyyaml installed to convert DMML to an OpenAPI 3.1 spec. This dependency is required to parse and process the YAML-based DMML documents before mapping them to the OpenAPI 3.1 specification structure.