Clean Architecture: TypeScript Expressย API
By employing clean architecture, you can design applications with very low coupling and independent of technical implementation details. That way, the application becomes easy to maintain and flexible to change. Clean architecture allows us to create architectural boundaries between dependencies which allows components to be swapped in and out and be intrinsically testable.
The Plan
At a high level, we'd like our API to be structured in the following way
Folder Structure
Let's use files and folders to structure our application. Doing this allows us to communicate architecture intent:
/src
โโโ main.ts
โโโ server.ts
โโโ presentation
โ โโโ routers
โ โโโ contact-router.ts
โโโ domain
โ โโโ interfaces
โ โ โโโ repositories
โ โ โ โโโ contact-repository.ts
โ โ โโโ use-cases
โ โ โโโ contact
โ โ โโโ create-contact-use-case.ts
โ โ โโโ delete-contact-use-case.ts
โ โ โโโ get-all-contacts-use-case.ts
โ โ โโโ get-one-contacts-use-case.ts
โ โ โโโ update-contact-use-case.ts
โ โโโ models
โ โ โโโ contact.ts
โ โโโ repositories
โ โ โโโ contact-repository.ts
โ โโโ use-cases
โ โโโ contact
โ โโโ create-contact.ts
โ โโโ delete-contact.ts
โ โโโ get-all-contacts.ts
โ โโโ get-one-contacts.ts
โ โโโ update-contact.ts
โโโ data
โโโ interfaces
โ โโโ data-sources
โ โโโ nosql-database-wrapper.ts
โ โโโ sql-database-wrapper.ts
โ โโโ contact-data-source.ts
โโโ data-sources
โโโ mongodb
โ โโโ mongodb-contact-data-source.ts
โโโ postgresl
โโโ pg-contact-data-source.ts
The presentation layer would mainly be used for inputting and outputting user data (API routes).
The inner core domain layer holds all business logic (use cases, repositories).
The data layer holds all infrastructure implementations (data sources).