ECommerce Service

In order to help you build your own Solution, find below an example of a complete and functional YAML model. It contains all sections that can serve as the foundation for your project.

This model example reflects a real use case for the eCommerce Service, which is intended to perform certain registration operations (CRUD) and customized queries to the database.

The features of this solution are:

• Customer registration;
• Product and Category registration;
• Purchase order registration;
• OData Query Controllers for customized data queries;
• User interface project/application for specified CRUD services

---

YAML Example:

Name: ECommerce # Solution name
RootNamespace: Sample.ECommerce # Solution root namespace

# Business entities

Entities:
- Name: Metatag1
  Properties:
  - Name: Keywords
    Type: string
  - Name: Description
    Type: string

- Name: Category
  KeyType: int
  Properties:
  - Name: Name
    Type: string
  - Name: Order
    Type: int
  - Name: Metatag
    Type: Metatag1
  - Name: Property
    Type: '[string]'
  - Name: Products
    Type: '[Product]' # Determines a relationship OneToMany with Product

- Name: Product
  KeyType: int
  Properties:
  - Name: Name
    Type: string
  - Name: Price
    Type: decimal
  - Name: Start_Promotion
    Type: DateTimeOffset
  - Name: End_Promotion
    Type: DateTimeOffset
  - Name: Category
    Type: Category # Determines a relationship OneToOne with Category
  - Name: Category_id
    Type: int
  - Name: ProductsSold
    Type: '[ProductSold]'

- Name: CustomerAddress
  KeyType: int
  Properties:
  - Name: Address
    Type: string
  - Name: Number
    Type: int
  - Name: City
    Type: string
  - Name: State
    Type: string
  - Name: Zip_Code
    Type: string
  - Name: Country
    Type: string
  - Name: Type
    Type: int
  - Name: Customer
    Type: Customer
  - Name: Customer_id
    Type: int

- Name: Customer
  KeyType: int
  Properties:
  - Name: Name
    Type: string
  - Name: Type
    Type: int
  - Name: Cpf
    Type: string
  - Name: Cnpj
    Type: string
  - Name: CustomerAddresses
    Type: '[CustomerAddress]'
  - Name: Orders
    Type: '[Order]'

- Name: ProductSold
  KeyType: int
  Properties:
  - Name: Order
    Type: Order
  - Name: Order_id
    Type: int
  - Name: Product
    Type: Product
  - Name: Product_id
    Type: int
  - Name: Price
    Type: decimal
  - Name: Quantity
    Type: int

- Name: Order
  KeyType: int
  Properties:
  - Name: Shipment
    Type: string
  - Name: Shipment_Value
    Type: decimal
  - Name: Discount
    Type: decimal
  - Name: Customer
    Type: Customer
  - Name: Customer_id
    Type: int
  - Name: ProductsSold
    Type: '[ProductSold]'

# Database instance types

DbInstances:
- Name: MyDbInstance01
  Type: SqlServer

# One database for all services

Databases:
- Name: MyDb01
  DbInstanceName: MyDbInstance01

# Identity Server configuration section

IdentityConfig:
  DatabaseName: MyDb01 # The database for Identity Server data storage

# Database data contexts

DbContexts:
- Name: Ctx01
  DatabaseName: MyDb01
  DbMappings: # Mapping between Entity and Database Tables
  - Name: CategoryDbMapping
    EntityName: Category
    Relationships:
    - ChildEntityName: Product
      ParentPropertyName: Products
      ChildPropertyName: Category
      Type: OneToMany
      ForeignKeyProperty: Category_id

  - Name: ProductDbMapping
    EntityName: Product
    Relationships:
    - ChildEntityName: ProductSold
      ParentPropertyName: ProductsSold
      ChildPropertyName: Product
      Type: OneToMany
      ForeignKeyProperty: Product_id

  - Name: CustomerDbMapping
    EntityName: Customer
    Relationships:
    - ChildEntityName: CustomerAddress
      ParentPropertyName: CustomerAddresses
      ChildPropertyName: Customer
      Type: OneToMany
      ForeignKeyProperty: Customer_id

    - ChildEntityName: Order
      ParentPropertyName: Orders
      ChildPropertyName: Customer
      Type: OneToMany
      ForeignKeyProperty: Customer_id

  - Name: CustomerAddressDbMapping
    EntityName: CustomerAddress

  - Name: OrderDbMapping
    EntityName: Order
    Relationships:
    - ChildEntityName: ProductSold
      ParentPropertyName: ProductsSold
      ChildPropertyName: Order
      Type: OneToMany
      ForeignKeyProperty: Order_id

  - Name: ProductSoldDbMapping
    EntityName: ProductSold

# Data access repository pattern

Repositories:
- Name: Repo01
  DbContextName: Ctx01
  EntityName: Category

- Name: Repo02
  DbContextName: Ctx01
  EntityName: Product

- Name: Repo03
  DbContextName: Ctx01
  EntityName: Customer

- Name: Repo04
  DbContextName: Ctx01
  EntityName: CustomerAddress

- Name: Repo05
  DbContextName: Ctx01
  EntityName: Order

- Name: Repo06
  DbContextName: Ctx01
  EntityName: ProductSold

# Validations rules for the business entity

EntityValidations:
- Name: ProductValidation_1
  Type: PropertyValidation
  EntityName: Product
  PropertyValidationParams:
  - PropertyName: Start_Promotion
    StopOnFirstRuleFailure: true
    Rules: # Pre-defined types that run sequentially
    - Type: IsNotEmpty
      Message: 'start_promotion is required'

    - Type: IsGreaterThan
      Expressions:
      - Value(@UtcToday) # Expression to get the current date
      Message: 'start_promotion must be greater than current date'

  - PropertyName: End_Promotion
    StopOnFirstRuleFailure: true
    Rules:
    - Type: IsNotEmpty
      Message: 'end_promotion is required'

    - Type: IsGreaterThan
      Expressions:
      - Value(@Prop::Start_Promotion) # Expression to get the value of another property
      Message: 'end_promotion must be greater than start_promotion'

- Name: IsCpfType
  Type: PropertyValidation
  EntityName: Customer
  PropertyValidationParams:
  - PropertyName: Type
    Rules:
    - Type: IsEqual
      Expressions:
      - Value(@ConstInt::1) # Expression to get the number 1 as constant

- Name: IsCnpjType
  Type: PropertyValidation
  EntityName: Customer
  PropertyValidationParams:
  - PropertyName: Type
    Rules:
    - Type: IsEqual
      Expressions:
      - Value(@ConstInt::2) # Expression to get the number 2 as constant

- Name: CustomerValidCPF
  Type: PropertyValidation
  EntityName: Customer
  PropertyValidationParams:
  - PropertyName: Cpf
    Rules:
    - Type: IsCpf
      Message: 'invalid CPF'

- Name: CustomerValidCnpj
  Type: PropertyValidation
  EntityName: Customer
  PropertyValidationParams:
  - PropertyName: Cnpj
    Rules:
    - Type: IsCnpj
      Message: 'invalid CNPJ'

# Services and Controllers (CRUD and QUERY)

Services:
- Name: OrderService
  Type: WebAPI
  Controllers:
  - Name: Category # Category registration
    Type: CRUD
    RepositoryName: Repo01
    EntityName: Category
    Contexts:
    - Context: Create
      Rules: # Business rules performed only for the "Create" context
      - Name: AddInRepository
        Type: WriteOperationRule # Executes a business rule for persisting data in the database
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule # Executes a business rule for reading data from the database
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: Product # Product registration
    Type: CRUD
    RepositoryName: Repo02
    EntityName: Product
    Contexts:
    - Context: Create
      Validations: # Validations performed only for the "Create" context
      - Name: ProductValidation
        Type: EntityValidation
        Order: 1
        ExecValidationName: ProductValidation_1 # Executes an EntityValidation type
      Rules:
      - Name: AddInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: Customer # Customer registration
    Type: CRUD
    RepositoryName: Repo03
    EntityName: Customer
    Contexts:
    - Context: Create
      Validations:
      - Name: CustomerValidCPF
        Type: EntityValidation
        Order: 1
        ExecValidationName: CustomerValidCPF # This validation is performed only if the conditional is valid
        ConditionalValidationName: IsCpfType # Conditional: Validates the CPF only if the customer type is "1-CPF"

      - Name: CustomerValidCnpj
        Type: EntityValidation
        Order: 2
        ExecValidationName: CustomerValidCnpj
        ConditionalValidationName: IsCnpjType
      Rules:
      - Name: AddInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: CustomerAddress
    Type: CRUD
    RepositoryName: Repo04
    EntityName: CustomerAddress
    Contexts:
    - Context: Create
      Rules:
      - Name: AddInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: Order # Purchase order registration
    Type: CRUD
    RepositoryName: Repo05
    EntityName: Order
    Contexts:
    - Context: Create
      Rules:
      - Name: AddInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: ProductSold
    Type: CRUD
    RepositoryName: Repo06
    EntityName: ProductSold
    Contexts:
    - Context: Create
      Rules:
      - Name: AddInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Update
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: UpdatePartial
      Rules:
      - Name: UpdateInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: Delete
      Rules:
      - Name: DeleteInRepository
        Type: WriteOperationRule
        Order: 1

    - Context: ReadAll
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

    - Context: ReadByKey
      Rules:
      - Name: ReadInRepository
        Type: ReadOperationRule
        Order: 1

  - Name: OrderQ
    Type: Query # OData Query pattern for custom queries
    RepositoryName: Repo05
    EntityName: Order

---

OData Example

## OData Query Sample:
...

  - Name: OrderQ
    Type: Query
    RepositoryName: Repo05
    EntityName: Order

...

Expand Request Example

https://loadbalancer.bea.internal:44300/ecommerce/odata/OrderQQuery?$expand=Customer($expand=CustomerAddresses),ProductsSold($expand=Product)

Response

{ 
    "@odata.context": "https://loadbalancer.bea.internal:44300/orderservice/odata/$metadata#OrderQQuery(Customer(CustomerAddresses()),ProductsSold(Product()))",
    "value": [
        {
            "Id": 1,
            "shipment": "Sedex",
            "shipment_value": 12.00,
            "discount": 2.90,
            "customer_id": 1,
            "Customer": {
                "Id": 1,
                "name": "test customer",
                "type": 1,
                "cpf": "80544235002",
                "cnpj": null,
                "CustomerAddresses": [
                    {
                        "Id": 1,
                        "address": "test address",
                        "number": 456,
                        "city": "test city",
                        "state": "SP",
                        "zip_code": "04001-001",
                        "country": "BRA",
                        "type": 1,
                        "customer_id": 1
                    }
                ]
            },
            "ProductsSold": [
                {
                    "Id": 1,
                    "order_id": 1,
                    "product_id": 1,
                    "price": 42.90,
                    "quantity": 2,
                    "Product": {
                        "Id": 1,
                        "name": "test product",
                        "price": 0.01,
                        "start_promotion": "2022-05-13T00:00:00Z",
                        "end_promotion": "2022-05-14T00:00:00Z",
                        "category_id": 1
                    }
                }
            ]
        }
    ]
}

---