Skip to content

pcesar-costa/nestjs-example

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NestJS Example

Exemplo de uma implementação simples baseado em NestJS em que abstrai:

  • Validators - camada entre a request e o controller
  • Services - camada intermediária entre os controllers e os repositórios
  • Repositories - camada de comunicação com o banco de dados

Instalação

$ npm install

Configure o banco de dados

Configure o arquivo ./db/db.module.ts com as credenciais do seu banco de dados. Documentação de referência: NestJS - configurando db

Executando a aplicação

Execute em watch mode (live reload):

$ npm run start:dev

Quero criar uma rota nova, como faço?

  1. Crie um model
  2. Crie o controller
  3. Crie o serviço apenas extendendo a classe base ServiceManager
  4. Crie o repositório apenas extendendo a classe base RepositoryManager
  5. Adicione os decorator do swagger para que sua rota fique documentada.
    1. Para que o model fique visível no swagger, é preciso adicionar um decorator a mais no controllador, como por exemplo no controller de User:
@ApiExtraModels(User)

É preciso fazer isso por conta que o NestJS não detecta/implementa os retornos do controllador, mais detalhes sobre isso pode ser consultado na documentação do Nesjs.

P.S.: a estrutura de pastas é apenas para fins didáticos. Altere conforme o freguês. Lembre-se, isso é apenas um exemplo.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors