DEV Community


Posted on


Build Restful Api With Nestjs the Right Way


If you are new with NestJS or you have been worked with it for several projects, this post is for you. In this article, I'll share with you the real world process to build a Restful API from scratch with NestJS

Okie, let's start. Imagination, we've already have detail specifications.
This is our requirements in this sample:

Create Restful API for a image storage service that allow:

  1. Users can register to the system. They need to verify their account before using it (via email).
  2. Users can only use the system if they have an active account
  3. Users can upload images with png,jpg,jpeg format. The maximum size is 5MB
  4. User's images won't be public unless they created a shared link and share with other people.
  5. User's images can be used on other websites
  6. A user has maximum 100 images.
  7. A system will delete unused image(unused more than 1 year) automatically every weekends.

Infrastructure requirements:

  1. Local : Local Docker
  2. Staging: Run on VM with Docker
  3. Production: Host everything on AWS

First of all, we need to write down what we have to do.

  • [x] Install NestJS CLI
  • [x] Setup your dev tools: vscode, config for debug, code linter
  • [x] Design source code structure: seperate them into layers
  • [x] Setup your local docker (database only)
  • [x] Setup your application's configuration
  • [x] Setup data access layer and configuration
  • [x] Business Layer: define business models: inputModels, outputModels
  • [x] Presentation Layer: define controllers
  • [x] Presentation Layer: integrate data validation from business models
  • [x] Business Layer: define business service
  • [x] Presentation Layer: integrate with business layer
  • [x] Presentation Layer: create swagger - the api document
  • [x] Persistence Layer: define database's entities, create and run migration scripts, seeds
  • [x] Persistence Layer: define repositories
  • [x] Business Layer: integrate repository with business layer
  • [x] Setup your staging docker: dockerfile, docker compose, setup scripts
  • [x] Setup your CI/CD flow and setup on your staging
  • [x] Design and setup AWS Infrastructure

And assume that we already have the high level designs

File Storage API

File Storage API Entities

File Storage API Endpoints

Step 1 : Install NestJS CLI

npm i -g @nestjs/cli
nest new your-project-name
Enter fullscreen mode Exit fullscreen mode

Step 2: Setup your dev tools

  1. How to debug NestJS in VSCode?


  "configurations": [
      "name": "Debug API",
      "type": "node",
      "program": "${workspaceFolder}/src/application/api/main.ts",
      "runtimeArgs": [
      "console": "integratedTerminal",
      "request": "launch",
      "skipFiles": ["<node_internals>/**"],
      "outFiles": ["${workspaceFolder}/**/*.js", "!**/node_modules/**"]
      "name": "Debug remote api",
      "type": "node",
      "request": "attach",
      "remoteRoot": "/app",
      "localRoot": "${workspaceFolder}",
      "port": 9229,
      "restart": true,
      "address": "",
      "skipFiles": ["<node_internals>/**"]
Enter fullscreen mode Exit fullscreen mode

Debug main app (file storage api)

F5 -> Select Debug API

Make sure your program path is your api's main file

Eg: "program": "${workspaceFolder}/src/application/api/main.ts",

Debug remote

Example: Start app in debug mode - debugger port 9229

F5 -> Select Debug remote API

npm run start:debug
Enter fullscreen mode Exit fullscreen mode

Step 3: Design source code structure

Overview layers

File Storage API clean architecture layer

  1. solutions
    • deployment -> deployment scripts, dockerfiles, k8s, ...
  2. src
  • src/application -> applications: file-storage-api, web, queues, ...
  • src/domain -> Tables mapping
  • src/business -> Business logic
  • src/share -> Share/Common projects
  • src/persistence -> TypeORM Core
  • src/config -> config: log,environment, configuration
  1. test -> test configuration

domain layer
File Storage API business layer

application layer
File Storage API application layer

business layer
File Storage API business layer

persistence layer
File Storage API persistence layer

config layer
File Storage API config layer

This is the high level of the design.

You can visit Build Restful Api With Nestjs the Right Way for more detail examples.

Have a good day!

Made with love by Nextjs VietNam

Top comments (2)

nguyenphucthien0992 profile image
Thien Nguyen 1992

^^ hay quá anh Sơn ơi :D

arcade_fyi profile image

Bro you god?!!
Thank you very much 🙌