Skip to content
Snippets Groups Projects
nestjs-micro-services.md 866 B
Newer Older
  • Learn to ignore specific revisions
  • Alessandro Cerioni's avatar
    Alessandro Cerioni committed
    # NestJS-based micro-services
    
    ## An overview of NestJS
    
    ...
    
    ## API documentation
    
    NestJS provides a [swagger module](https://docs.nestjs.com/recipes/swagger) 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](https://github.com/nestjs/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