Projeto desenvolvido na disciplina de projeto de software - 2019.2. Trata-se de um sistema de crowdfunding onde existem usuarios e esses usuarios cadastram campanhas, fazem doações, comentarios e dão likes em campanhas.
O deploy da nossa api está disponível em:
https://projsoftajude.herokuapp.com/v1/api
Nossa documentação gerada pelo swagger está disponível em
http://projsoftajude.herokuapp.com/v1/api/swagger-ui.html#/
Escolhemos um tempo de expiração de 7 (sete) minutos para o token, por julgarmos que seria o tempo adequado para um usuario doar para uma campanha, e por se tratar de um sistema que envolve dinheiro, a escolha de um tempo menor aumentaria a segurança dos dados do usuário.
Segue o link video que explica nossa aplicação
https://youtu.be/KYBx7qAAUcc
email: [email protected]
senha: admin
email: [email protected]
senha: admin1
Lista de rotas disponíveis pela nossa API. rotas que contém /auth/ devem ser autenticadas por meio da rota de login.
-
v1/api/usuarios adiciona um usuário novo, depois de verificar que o email ja nao existia no sistema
body da requisição:
{ "nome":"nome-do-usuario", "ultimoNome":"ultimo-nome-do-usuario", "email":"email-do-usuario", "cartaoDeCredito":"cartao-de-credito", "senha":"senha-do-usuario" }retorna
-
200, se o usuario for criado
-
409, se ja existir um usuario com aquele email
-
-
v1/api/usuarios retorna uma lista com todos os usuarios
- 200, se ocorrer tudo bem
-
v1/api/usuarios/{email} retorna o usuario do email na URI, caso exista.
-
200, se o usuario existir
-
404, se o usuario nao existir
-
-
v1/api/usuarios/campanhas/{email} retorna a lista de campanhas que o usuario é dono
-
200, se ocorrer tudo bem
-
400, se o usuario não existir
-
-
v1/api/usuarios/{email} muda a senha do usuario do email na URI, caso exista, e retorna o usuario
body da requisição:
{ "senha":"nova-senha-do-usuario" }retorna
-
200, se ocorer tudo bem
-
404, se o usuario não existir
-
-
v1/api/login/usuarios faz login de um usuario (autentica), caso o usuario exista
body da requisição:
{ "email":"email-do-usuario", "senha":"senha-do-usuario" }retorna
- 200, se o usuario conseguir se logar e o json com o token
{ "token":"token-retornado-pelo-servidor" }-
401, se a senha for inválida
-
404, se o email não existir
-
v1/api/auth/campanha adiciona uma nova campanha ao sistema
body da requisição:
{ "nome":"nome-da-campanha", "descricao":"descricao-da-campanha", "dataLimite":"YYYY-MM-DD", "meta": meta-da-campanha }retorna
-
201, se a campanha for cadastrada com sucesso
-
404, se houver algum erro
-
-
v1/api/campanha/{url} retorna a campanha correspondente à url na URI, caso a campanha exista
retorna
-
200, se a campanha existir
-
400, se a campanha não existir
-
-
v1/api/campanha/find/busca=?{substring} retorna uma lista com todas as campanhas que contenham a string como substring no título
retorna
- 200, se ocorrer tudo bem
-
v1/api/campanha/find/descr/busca=?{substring} retorna uma lista com todas as campanhas que contenham a string recebida como substring no título OU na descrição
return
200, se ocorrer tudo bem
-
auth/campanha/doacao retorna todas as campanhas que um usuario doou
retorna
-
200, se o usuario existir
-
400, se o usuario não existir
-
-
v1/api/auth/campanha/encerrar/{url} o usuario que for dono da campanha corresponde à url na URI pode encerrá-la
retorna
-
200, se ocorrer tudo bem
-
400, se a campanha não existir
-
-
v1/api/auth/campanha/deadline/{url} o usuario que for dono da campanha corresponde à url na URI pode mudar a data que ela vence
body da requisição:
{ "data":"YYYY-MM-DD" }retorna
-
200, se ocorrer tudo bem
-
400, se houver algum erro
-
-
v1/api/auth/campanha/meta/{url} o usuario que for dono da campanha corresponde à url na URI pode alterar a meta de doações
body da requisição:
{ "meta": nova-meta-da-campanha }retorna
-
200, se ocorrer tudo bem
-
400, se houver algum erro
-
-
v1/api/auth/campanha/descricao/{url} o usuario que for dono da campanha corresponde à url na URI pode alterar a descrição
body da requisição:
{ "descricao": "nova-descricao-da-campanha" }retorna
-
200, se ocorrer tudo bem
-
412, se a campanha não estiver ativa
-
403, se o usuario não for dono
-
404, se a campanha não existir
-
-
v1/api/auth/comentario adiciona um comentario a uma campanha, usuario deve estar autenticado
body da requisição, caso seja um comentario a uma campanha:
{ "comentario":"comentario-do-usuario", "idCampanha": id-da-campanha-a-ser-adicionado-o-comentario }body da requisição, caso seja uma resposta a um comentario:
{ "comentario":"comentario-do-usuario", "idComentario": id-do-comentario-a-ser-respondido }retorna
-
200, se o comentario for adicionado
-
404, se a campanha ou o comentario não exitir
-
-
v1/api/comentario/campanha/{url} retorna a lista com todos os comentarios da campanha correspondente ao id da URI
retorna
-
200, se ocorrer tudo certo
-
404, se a campanha não existir
-
-
v1/api/comentario/respostas/{id} retorna a lista de todos os comentarios que referenciam ao comentário correspondente ao id da URI
retorna
-
200, se correu tudo bem
-
400, se o comentario não existe
-
-
v1/api/auth/comentario/usuario retorna uma lista com todos os comentarios feitos pelo usuário autenticado que faz a requisição
retorna
-
200, se tudo correu bem
-
400, se o usuario não foi encontrado
-
-
v1/api/auth/comentario/deletar/{id} deleta o comentario correspondente ao id na URI, o usuário que tenta apagar deve ser o mesmo usuário que criou o comentario e o deve estar autenticado. Todos os comentarios resposta deste comentario que esta sendo deletado devem ser deletados em cascata.
retorna
-
200, se tudo correu bem
-
403, se usuario não é o dono
-
404, se algo deu errado
-
-
v1/api/auth/like usuário autenticado dá like em uma campanha
body da requisição:
{ "urlCampanha":"url-da-campanha-a-fazer-a-doacao" }retorna
-
201, se ocorreu tudo bem
-
409, se esse usuario ja deu like
-
404, se não existe usuario ou campanha
-
-
v1/api/likes/campanha/{url} retorna uma lista com todos os likes que foram dados à campanha correspondente à url passado na uri
retorna
-
200, se tudo correu bem
-
400, se não foi encontrada uma campanha com aquela url
-
-
v1/api/auth/likes/usuario retorna uma lista com todos os likes dados pelo usuário autenticado que fez a requisição
retorna
-
200, se tudo correu bem
-
400, se o usuario não existe
-
-
v1/api/auth/like/campanha/remove/{url} o usuário dono do like pode retirá-lo de uma campanha correspondente à url na URI, usuário deve estar autenticado
retorna
-
200, se tudo correu bem
-
400, se a url da campanha ou o usuario não existe
-
-
v1/api/auth/dislike um usuário autenticado pode dar dislike em uma campanha
body da requisição:
{ "urlCampanha":"url-da-campanha" }retorna
-
201, se correu tudo bem
-
409, se o usuario já deu dislike
-
404, se o usuario ou a campanha não existe
-
-
v1/api/dislikes/campanha/{url} retorna uma lista com todos os dislikes da campanha correspondente à url na URI
retorna
-
200, se correu tudo bem
-
400, se a campanha não existe
-
-
v1/api/auth/dislikes/usuario retorna uma lista com todos os likes que foram dados pelo usuário autenticado que fez a requisição
retorna
-
200, se correu tudo bem
-
400, se o usuario não existe
-
-
v1/api/auth/dislike/campanha/remove/{url} o usuário dono do dislike pode retirá-lo de uma campanha correspondente à url na URI, usuário deve estar autenticado
retorna
-
200, se correu tudo bem
-
400, se a campanha não existe
-
-
v1/api/auth/doacao adiciona uma doação a uma capanha, o usuario tem que estar autenticado para realizar a doação
body da requisição:
{ "quantia":quantia-doada, "urlCampanha":"url-da-campanha-que-vai-receber" }retorna
-
200, se tudo correu bem
-
400, se o usuario ou a campanha não existe
-
-
v1/api/doacoes/campanha/{url} retorna todas as doações realizadas a uma campanha
retorna
-
200, se tudo correu bem
-
400, se a campanha não foi encontrada
-
-
v1/api/auth/doacoes/usuario retorna todas as doações feitas por um usuario
retorna
-
200, se tudo correu bem
-
400, se o usuario não existe
-