/API-Test-Typeorm

A restfull Api builted with NodeJs

Primary LanguageTypeScript

Rest API

GitHub issues GitHub forks GitHub stars GitHub license GitHub language count GitHub top language

GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) GitHub package.json dependency version (prod)

Run in Insomnia}

Rodando o projeto

  • Para testar a Api basta clonar o repositório e iniciar o script yarn dev, isto abrirá rodará o servidor de desenvolvimento.

  • Todas as rotas estão no arquivo do INSOMNIA que pode ser usado apenas clicando no botão RUN ON INSOMNIA

Funcionalidades

  • Autenticação
    • Rota de cadastro (Signup)
      • Coloque o email e a senha para criar um novo regisro no banco.
    • Rota de login (Login)
      • Coloque o email e a senha, previamente cadastrados, retornará um JWT(Json Web Token)

Obs: Como esse foi um projeto com fim pedagógico, apenas para conhecer melhor as tecnologias utilizadas, vale ressaltar que NÃO encriptei as senhas salvas e nem utilizei variáveis de ambiente.

  • Rotas privadas

    • Navers

      • Show All
        • Esta rota ela mostra todos os Navers cadastrados no banco de dados
        • Aceita query strings, como name, admissionDate e jobRole para filtar a resposta da API.
      • Single Naver
        • Recebe o id do Naver como parâmetro da URL.
        • O retorno é o Naver desejado com todos os projetos que ele participa.
      • Create Naver
        • Recebe os dados através do Body e cria um novo naver.
      • Update Naver
        • Recebe do Body a atualização do naver desejado.
      • Delete Naver
        • Recebe o id do naver via parâmetro da URL e deleta o naver.

    • Projects

      • Show All
        • Esta rota ela mostra todos os Projects cadastrados no banco de dados
        • Aceita query strings, como name, userId e naversId para filtar a resposta da API.
      • Single Project
        • Recebe o id do Project como parâmetro da URL.
        • O retorno é o Project desejado com todos os navers participam dele.
      • Create Project
        • Recebe os dados através do Body e cria um novo project.
      • Update Project
        • Recebe do Body a atualização do Project desejado.
      • Delete Project
        • Recebe o id do project via parâmetro da URL e deleta o project.

Tecnologias