Documented and live — Capstone: the shelter service · NestJS

Make the service readable and watchable: an OpenAPI document that says which routes need a token and what every body looks like, and adoptions announced to every connected screen the moment they are committed, and never when they are rolled back.

What you will learn

Read the theory for Documented and live

All Capstone: the shelter service lessons

All NestJS courses

loading types…

What you'll learn

  • Document a whole API with @nestjs/swagger: tags per controller, bearer authentication on the routes that need it, and DTO schemas with the same limits the validators enforce
  • Derive an update DTO with @nestjs/swagger's PartialType so the document describes it too
  • Announce a change from a service through a gateway the service injects
  • Announce only what was committed: after the transaction, never inside it