Piece of my thoughts about Node.js architecture.

supra-api-nodejs: A little bit about Node.js RESTful APIs Architecture (RU)

• Modular RESTful API
• ES6 Classes
• Action based
• SQL based (PostgreSQL with objection.js)
• Migrations(knex.js)
• Auth (JWT/Access-token/Refresh-token)
• Cookie support
• Role based access control
• Request validation
• CRUD(users, posts resources)
• Automated API documentation
• Full authentication/authorization and user registration flow implemented
• Tests(e2e)

Supra-api-nodejs its about monolith first approach. But this does not prevent you from using it in a microservice architecture as well.

Each entity have own controller class it slim layer representing resource mapping(routing)

class PostsController extends BaseController {
  static get router () {
    router.get('/', this.actionRunner(actions.ListAction))
    router.get('/:id', this.actionRunner(actions.GetByIdAction))
    router.post('/', this.actionRunner(actions.CreateAction))
    router.patch('/:id', this.actionRunner(actions.UpdateAction))
    router.delete('/:id', this.actionRunner(actions.RemoveAction))

    return router
  }
}

For example PostsController implements post entity routes. Each route fires own action.

It's a class encapsulated request validation, permission verification and business logic. One file, one class, one REST operation, one use case.

Implement data access methods.

Represent models schemas and validation rules. There is no other logic only model fields and validation rules.

npm i -g knex nodemon

1. Install PostgreSQL (https://postgresapp.com/downloads.html (for Mac OS))
2. Create some DB (https://eggerapps.at/postico/ (for Mac OS))

cd /supra-api-nodejs

• cp .env.example .env
• Set required credential in .env

Run migration to set base SQL schema

knex migrate:latest

Run server

npm run start // prod mode
npm run dev // dev mode

!!! Project still in progress !!!

2017 - 2018 - 2019 - 2020 ...