nestjs-micro-services.md

NestJS-based micro-services

An overview of NestJS

...

API documentation

NestJS provides a swagger module that can be easily integrated. By using dedicated annotations alongside the various endpoint declarations, the developer can provide the module information to automatically generate a swagger documentation, reachable at /api-doc.

Health checks

NestJS provides a health module based on Terminus, allowing developers to declare predefined and/or custom health indicators. By default, the health status of a given NestJS service is available through the /health endpoint.

A service will return a 200 http status code when all indicators are healthy. Otherwise it will return a 503 http status code.

Logging

Guards or how to implement an AUTHZ layer