A data model defines the resources, relationships, terminology, and operations an API exposes. Aligning designers and stakeholders around this conceptual model clarifies API definitions before implementation and supports consistent resource naming. section 5.2.4 section 1.7
Capture the model by:
- Identifying the resources and operations that support user outcomes. section 5.2.4
- Recording entities and relationships with entity-relationship diagrams, tables, or equivalent artifacts. section 5.2.4
- Reviewing the model with relevant roles before automating standards checks; automation cannot replace agreement on terminology or resource design. section 1.7 section 5.2.4
Product Catalog API
A Product Catalog API models products, reviews, and categories. Each review belongs to exactly one product; a product may have zero or more reviews. Products may belong to multiple categories, while categories may contain zero or more products. An operations table can map actions such as listing categories, viewing products, and listing product reviews to resources, requests, and responses. section 5.2.4
