Desafio API Perguntas e Respostas BeeDoo

Proposta

Criar uma API em NodeJS no padrão RestFULL que realizasse as seguintes funções listadas abaixo:

[X] Adicionar uma nova PERGUNTA
[X] Listar todas as PERGUNTAS
[X] Alterar uma PERGUNTA
[X] Deletar uma PERGUNTA
[X] Adicionar opções de resposta a uma PERGUNTA. (sem limites)
[X] Listar todas as opções de RESPOSTAS de uma PERGUNTA
[X] Alterar uma opção de RESPOSTA de uma PERGUNTA
[X] Deletar uma opção de RESPOSTA de uma PERGUNTA

Para completar o desafio foram utilizadas as seguintes tecnologias:

Plataforma de Aplicações: NodeJs
Banco de Dados: MySQL
Framework: { 
    Sequelize,
    Express
}

Como usar

Para iniciar o projeto, faça um clone deste repositório. Altere o nome do arquivo .env.example para .env e caso necessário faça as devidas alterações de acesso nas variaveis de ambiente.

É NECESSÁRIO A UTILIZAÇÃO DO DOCKER Para iniciar a aplicação, navegue até a pasta do projeto. Abra um terminal e digite docker-compose up e aguarde a finalização

juntamente com a pasta do projeto será disponibilizado o arquivo Insomnia_2022-05-03.json que contem todas as requests feitas através do api client insomnia

Models

Perguntas [ { 
    id: integer, not null, auto increment, primary key,
    pergunta: string, not null
} , . . . ]

Respostas[ { 
    id: integer, not null, auto increment, primary key,
    resposta: string, not null,
    resposta_valida: boolean,  not null,
    pergunta_id: integer, not null
} , . . . ]

Rotas

Para este projeto, foram elaborados 2 rotas: Ambas as rotas utilizam os principais verbos HTTP: GET / POST / PUT / DELETE

- /perguntas
    rota: /
    exibe todos as perguntas cadastradas
    
    rota: /add
    cadastra uma nova pergunta
    
    rota: /edit/:id
    altera uma pergunta ao informar o (id:number) ao parametro da URL
    
    rota: /del/:id
    deleta uma pergunta ao informar o (id:number) ao parametro da URL, uma pergunta ao ser deletada, apaga todas as suas respectivas respostas

    exemplo: http://localhost:4444/pergunta/
    exemplo: http://localhost:4444/pergunta/add
    exemplo: http://localhost:4444/pergunta/edit/:id
    exemplo: http://localhost:4444/pergunta/del/:id

- /respostas
    rota: /
    Exibe todas as perguntas cadastradas no banco de dados

    rota: /resposta?pergunta="id" (mesma rota acima com parametro querystring)
    onde pergunta é um parametro de "query" que realiza a busca de todas respostas associadas a uma determinada pergunta através do campo `pergunta_id`

    rota: /add/:id 
    realiza N cadastros de respostas associadas a uma pergunta, onde (id:number) está diretamente vinculada ao campo (pergunta_id) no ato de sua criação no banco de dados

    rota: /edit?pergunta="id"&resposta="id"
    realiza atualização de uma resposta X  (pergunta_id) correspondente a uma pergunta Y, caso o i da pergunta não seja enviado a consulta não é realizada retornando um erro, caso a pergunta seja informada mas não haja respostas associadas a pergunta um erro será retornado ao usuário

    rota: /del?pergunta="id"&resposta="id"
    realiza remoçao de uma resposta X  (pergunta_id) correspondente a uma pergunta Y, caso o id da perguntanão seja enviado a consulta não é realizada retornando um erro, caso a pergunta seja informada mas não haja respostas associadas a pergunta um erro será retornado ao usuário
    
    exemplo: http://localhost:4444/resposta
    exemplo: http://localhost:4444/resposta?pergunta=1
    exemplo: http://localhost:4444/resposta/add/1
    exemplo: http://localhost:4444/resposta/edit?pergunta=1&resposta=6         
    exemplo: http://localhost:4444/resposta/del?pergunta=1&resposta=4
    

Dúvidas

Qualquer dúvida/problema referente ao projeto, sinta-se livre para abrir uma issue no projeto que eu responderei o mais breve possível.

To-Do

[X] Utilizar docker para comunicação da aplicação nodejs e mysql
[ ] Implementação de testes