Skip to main content

0013 - Deprecate global request/response models

ID:ADR-0013
Status:ACCEPTED
Published:2022-09-16

Context and Problem Statement​

Our Angular application currently partially uses a layered folder structure. This results in a domain context being split between multiple folders several levels deep. This causes friction since modifying services often requires modifying the models belonging to that service.

Understandably our application uses a lot of models, however the biggest and most isolated part of the models are the request and responses. Which makes them a good starting point.

Considered Options​

  • Continue as is - We can continue as we are, and continue to put models in libs/common/models.
  • Place models next to their owner - Request and responses are owned by a single API service. They can therefore be placed close to their service which keeps connected changes close to each other.

Decision Outcome​

Use the Place models next to their owner for request and response models.

A rule of thumb is to put any model that is used in the abstraction in the abstraction directory. And any model used in the service in the service directory. Abstractions are part of the service public interface, while services are part of the internal interface.

Example​

libs/common/
  abstractions/folder/
    folder.service.abstraction.ts
    folder-api.service.abstraction.ts
    responses/
      folder.response.ts  (Exposed as public API)
  services/folder/
    folder.service.ts
    folder-api.service.ts
    requests/
      folder.request.ts  (Internal, only used within the implementation)