Coder Social home page Coder Social logo

loryblu / loryblu-api Goto Github PK

View Code? Open in Web Editor NEW
2.0 0.0 5.0 626 KB

API para o aplicativo LoryBlu. Um aplicativo pensado para ajudar pais e crianças diagnosticadas com TEA.

License: MIT License

JavaScript 1.09% Shell 0.10% PLpgSQL 2.83% TypeScript 95.98%
nestjs postgresql prisma-orm soujunior-labs

loryblu-api's People

Contributors

daaaiii avatar lauanegcsilva avatar viniciuscosmome avatar

Stargazers

 avatar  avatar

loryblu-api's Issues

LOR 177 - Padronização das respostas

Discussed in #26

Originally posted by viniciuscosmome October 6, 2023

Decisão final de mudanças

type response = {
  message: string;
  data?: object | undefined;
  details?: Array<{
    property?: string | undefined;
    message: string;
  }> | undefined;
};
Propriedade Descrição Conteúdo
message Presente em todas as respostas Uma descrição geral sobre a resposta
data Presente nas respostas de sucesso Traz um objeto que contém conteúdos requisitados pelo client
details Presente nas respostas de erro Traz uma lista que contém detalhes sobre os erros

Algumas tarefas que precisam ser feitas 🏗️

Important

Adicione um comentário referenciando a PR para concluir cada pendência.

1. Dependências chore(deps)

  • A versão do prisma 5.2.0 não é compatível com a nova versão do @prisma/client 5.3.1. Isso pode gerar alguns comportamentos inesperados.

Tarefas

  • Atualizar a versão do prisma para 5.3.1. Lembre-se de que esta é uma dependência de desenvolvimento.

2. Mudanças chore

  • Importar apenas módulos e recursos que serão necessários para o módulo referente (o jwtModule).

Tarefas

  • Remover a importação de AccountService, AccountRepository, AccountModule e AuthModule do módulo account.auth.module,

3. Refatoração refactor

  • O arquivo com os métodos responsáveis por fazer consultas na base de dados são os "repository".
  • Nome das pastas e arquivos devem ser simples mas descritivos.
  • As exceções das falhas na autenticação do usuário devem ter mensagens genéricas, e estar listadas nas exceções (porque futuramente terá um logger).

Tarefas

  • Criar um arquivo para o módulo jwtModule que é responsável pelas consultas na base de dados.
  • Alterar o nome dos arquivos dentro de jwtModule de account.auth.[...] para auth.[...].
  • Alterar o nome do módulo de jwtModule para authentication ou auth.
  • Criar exceções genéricas para falha na autenticação das credenciais do usuário no arquivo:
    src/globals/responses/exceptions/general.exceptions.ts, Adicione na seção do código de erro respectivo.

4. Documentação docs

  • As respostas possíveis das rotas devem estar documentadas no swagger

Tarefas

  • Adicionar as respostas da rota na documentação.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.