nguyenhoaiphuoc1995 / rest-api

REST API Blueprint with Clean Architecture

REST API Blueprint

Architecture

Clean Architecture

Design Pattern

• Factory
• DIP : Dependency inversion principle

Rules

• SOLID

Layers

Application: api Domain : entities, contracts, services, factories, repositories (abstract) Persistence: repositories, orm entities Config: configuration class Shared: shared functions Tools: other tools

Getting start

• Configuration: copy and replace related env

cp .env.sample .env

Production

touch .env.production
echo "DATABASE_URL=mysql://root:123456@db/rest_api" > .env.production

DB Migration

yarn typeorm migration:generate -n CreateUserTable
yarn typeorm migration:run
yarn typeorm migration:show

Docker

docker-compose -f ./docker-compose.dev.yml up
docker container exec -it rest-api-restapi-1 sh
yarn typeorm migration:show
yarn typeorm migration:run

docker-compose up -d
docker container exec -it rest-api-restapi-1 sh

docker-compose down
docker rmi $(docker images -aq --filter=reference='restapi')
docker volume rm rest-api_db_data

MYSQL

docker run --name jsguru-db -p 3307:3306 -e MYSQL_ROOT_PASSWORD=123456 -e MYSQL_DATABASE=rest-api -e MYSQL_USER=jsguru -e MYSQL_PASSWORD=123456 mysql:8.0.28 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci