API desenvolvida como teste para a vaga de desenvolvedor backend Java Jr da Magazord. Trata-se de uma API CRUD para receitas conforme esquema abaixo
{
"_id": "5bc698399531146718e31220",
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"likes": [
"123",
"456"
],
"ingredients": [
"ovo",
"chocolate"
],
"comments": [
{
"_id": "5bc6a737953114503ce9cd7f",
"comment": "Muito gostoso!"
}
]
}Para utilizar/testar essa API é necessário baixar o arquivo zord-recipe-api-0.0.1-SNAPSHOT-jar-with-dependencies.jar que está na pasta target desse repositório e executar o comando
java -jar zord-recipe-api-0.0.1-SNAPSHOT-jar-with-dependencies.jar
em um terminal aberto no mesmo diretório que se encontra o arquivo baixado. Para executar o arquivo jar é necessário ter
a JRE ou JDK versão 11 instalada. Assim como o banco de dados NoSQL MongoDB configurado na porta 27017.
Endpoint utilizado para cadastrar uma nova receita no banco de dados. Recebe um request body com exemplo abaixo
{
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"ingredients": [
"ovo",
"chocolate"
]
}E retorna um response body com o objeto criado e com o id gerado
{
"id": "639cb6ffe478d8453d857150",
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"ingredients": [
"ovo",
"chocolate"
],
"likes": [],
"comments": []
}Esse endpoint retorna todas as receitas cadastradas no banco de dados conforme modelo abaixo. Retorna também HTTP status OK.
[
{
"id": "639c7d79bf89243463a2cda5",
"title": "Feijoada",
"description": "Feijoada deliciosa para o fim de semana",
"ingredients": [
"Feijão",
"Bacon",
"Calabresa",
"Água",
"Sal",
"Alho",
"Cebola",
"Folhas de Louro"
],
"likes": [
789,
510
],
"comments": [
{
"id": "639ceee224b7837da5bf1780",
"comment": "Excelente receita!"
}
]
},
{
"id": "639c7dfbbf89243463a2cda6",
"title": "Pão com banana e queijo",
"description": "Receita deliciosa para um café da manhã mais saudável",
"ingredients": [
"1 Banana",
"2 Fatias de pães",
"2 Fatias de queijo",
"Requeijão"
],
"likes": [
759,
7596546,
7596
],
"comments": []
},
{
"id": "639cb6ffe478d8453d857150",
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"ingredients": [
"ovo",
"chocolate"
],
"likes": [],
"comments": [
{
"id": "639cf8bf24b7837da5bf1783",
"comment": "Topzera!"
}
]
}
]Esse endpoint retorna uma lista de receitas que contém o ingrediente passado como parâmetro de consulta na requisição.
Por exemplo, a request localhost:8080/recipe/ingredient?ingredient=Banana irá retornar uma array de receitas que
contém o ingrediente Banana e o HTTP status 200
[
{
"id": "639c7dfbbf89243463a2cda6",
"title": "Pão com banana e queijo",
"description": "Receita deliciosa para um café da manhã mais saudável",
"ingredients": [
"1 Banana",
"2 Fatias de pães",
"2 Fatias de queijo",
"Requeijão"
],
"likes": [
759,
7596546,
7596
],
"comments": []
}
]Caso a array retornada seja vazia, um erro padrão juntamente com o HTTP status Not Found (404) é retornado.
Por exemplo, a request localhost:8080/recipe/ingredients?ingredients=banana irá retornar um response
body como abaixo, pois a consulta realizada no banco de dados é case sensitive
{
"timestamp": "1671233843297",
"status": "404 Not Found",
"error": "Nenhuma receita encontada!",
"path": "/recipe/ingredient"
}Assim como o endpoint acima, esse também realiza buscas e retorna uma array de receitas a partir de um parâmetro de consulta. Todavia, a consulta é realizada tanto no título quanto na descrição da receita.
Por exemplo, a requisção localhost:8080/recipe/search?search=deliciosa irá retornar todas as receitas que contém a
palavra deleciosa no título ou na descrição da receita
[
{
"id": "639c7d79bf89243463a2cda5",
"title": "Feijoada",
"description": "Feijoada deliciosa para o fim de semana",
"ingredients": [
"Feijão",
"Bacon",
"Calabresa",
"Água",
"Sal",
"Alho",
"Cebola",
"Folhas de Louro"
],
"likes": [
789,
510
],
"comments": [
{
"id": "639ceee224b7837da5bf1780",
"comment": "Excelente receita!"
}
]
},
{
"id": "639c7dfbbf89243463a2cda6",
"title": "Pão com banana e queijo",
"description": "Receita deliciosa para um café da manhã mais saudável",
"ingredients": [
"1 Banana",
"2 Fatias de pães",
"2 Fatias de queijo",
"Requeijão"
],
"likes": [
759,
7596546,
7596
],
"comments": []
}
]Vale ressaltar que as receitas retornadas estarão ordenadas de forma alfabética crescente a partir do título. Esse endpoint também retorna um erro padrão e um HTTP status 404 caso não seja encontrado nenhuma receita com o parâmetro de consulta passado na URI.
Esse endpoint retorna uma única receita caso o id passado na URI exista. Por exemplo, a
request localhost:8080/recipe/639c7d79bf89243463a2cda5 irá retornar a receita que contém o
id 639c7d79bf89243463a2cda5, como exemplo abaixo, e
o HTTP status 200
{
"id": "639c7d79bf89243463a2cda5",
"title": "Feijoada",
"description": "Feijoada deliciosa para o fim de semana",
"ingredients": [
"Feijão",
"Bacon",
"Calabresa",
"Água",
"Sal",
"Alho",
"Cebola",
"Folhas de Louro"
],
"likes": [
789,
510
],
"comments": [
{
"id": "639ceee224b7837da5bf1780",
"comment": "Excelente receita!"
}
]
}Caso não seja encontrado uma receita com o id fornecido, um erro padrão é retornado asism como o HTTP status 404
{
"timestamp": "1671237132883",
"status": "404 Not Found",
"error": "Receita id: 639c7d79bf89243463a2cda5asdfa não encontrada!",
"path": "/recipe/639c7d79bf89243463a2cda5asdfa"
}Esse endpoint atualiza a receita que tem o id passado URI. Os dados dessa receita são alterados para aqueles passados no request body.
Por exemplo, a requisição PUT localhost:8080/recipe/639cb6ffe478d8453d857150 com o request body abaixo
{
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"ingredients": [
"ovo",
"chocolate",
"açucar",
"farinha"
],
"likes": [],
"comments": [
{
"id": "639cf8bf24b7837da5bf1783",
"comment": "Topzera!"
}
]
}Irá retornar o HTTP status No Content (204) e terá atualizado o a receita com o id 639cb6ffe478d8453d857150. Caso não
exista uma receita com o id passado na URI, então um erro padrão e um HTTP status 404 são retornados
{
"timestamp": "1671237774339",
"status": "404 Not Found",
"error": "Não foi possível atualizar a receita. Id: 639cb6ffe478d8453asdfasd857150 inexistente!",
"path": "/recipe/639cb6ffe478d8453asdfasd857150"
}Endpoint utilizado para excluir uma receita do banco de dados. Caso a receita contenha algum comentário, esses também são excluídos do banco de dados. Pois os comentários são salvos em uma collection separada e uma cópia de cada comentário é agregada às receitas. Após excluir as receitas e os comentários agregados a ela, é retornado um HTTP status 204.
Se não for encontrado nenhum usuário com o id passado na URI, será retornado um HTTP status 404 e um erro padrão como abaixo
{
"timestamp": "1671238204203",
"status": "404 Not Found",
"error": "Receita id: 639c7cfcbf89243463a2acda4sdfa não encontrada!",
"path": "/recipe/639c7cfcbf89243463a2acda4sdfa"
}Esse endpoint adiciona o userId passado na URI a uma lista de ids de usuários que deram like na receita que contém o id também passado na URi. Retorna HTTP status 201, assim como a receita com a lista de likes atualizada.
Por exemplo, a request localhost:8080/recipe/639cb6ffe478d8453d857150/153 irá retornar
{
"id": "639cb6ffe478d8453d857150",
"title": "Bolo de chocolate",
"description": "Bolo de chocolate caseiro",
"ingredients": [
"ovo",
"chocolate",
"açucar",
"farinha"
],
"likes": [
153
],
"comments": [
{
"id": "639cf8bf24b7837da5bf1783",
"comment": "Topzera!"
}
]
}Na aplicação, o userId foi tipado com a Wrapper Class Integer. Ou seja, o userId passado na URI será parseado e caso ocorra algum problema, um erro padrão é retornado no corpo da resposta assim como um HTTP status 400 como abaixo
{
"timestamp": "1671239106029",
"status": "400 Bad Request",
"error": "Id inválido!",
"path": "/recipe/639cb6ffe478d8453d857150/like/153asd"
}E caso não seja encontrado nenhuma receita com o id passado na URI, também é retornado um erro padrão com o HTTP status 404, assim como nos outros endpoints. Caso o userId informado na URI já esteja presente na lista de likes da receita, também é retornado um erro padrão como o exemplo abaixo e um HTTP status Conflict (409).
{
"timestamp": "1671408098079",
"status": "409 Conflict",
"error": "Usuário id: 153 já curtiu a receita id: 639cb6ffe478d8453d857150!",
"path": "/recipe/639cb6ffe478d8453d857150/like/153"
}Endpoint utilizado para dar deslike em uma receita. Em outras palavras, o recurso remove o userId passado na URI da lista de likes da receita que contiver o id passado na URI.
Por exemplo, a request localhost:8080/recipe/639cb6ffe478d8453d857150/153
irá deletar da lista de likes da receita id 639cb6ffe478d8453d857150 o userId 153 e retornar o HTTP status 204.
Caso o userId não exista ou caso a receita não exista, a API retorna um erro padrão com HTTP status 404.
{
"timestamp": "1671407997957",
"status": "404 Not Found",
"error": "O usuário id: 789 não curtiu a receita id: 639c7d79bf89243463a2cda5!",
"path": "/recipe/639c7d79bf89243463a2cda5/like/789"
}Utilizado para adicionar um comentário a uma receita. Assim como nos outros edpoints, também retorna um erro padrão e HTTP status 404 caso o id da receita não seja encontarado. No request body, é preciso ser informado um JSON contendo o comentário que será inserido na receita.
Por exemplo a requisição localhost:8080/recipe/639c7dfbbf89243463a2cda6/comment com o request body abaixo
{
"comment": "Bom demais!"
}Irá incluir um comentário na receita id 639c7dfbbf89243463a2cda6 e irá retornar no corpo da resposta o comentário com
um id gerado pelo mongodb
{
"id": "639fab63b98c514ab6363b96",
"comment": "Bom demais!"
}Como já mencionado anteriormente, a receita é salva em uma collection separada da recieta no banco de dados e uma cópia é adicionada a array de comentários da receita.
Utilizado para atualizar um comentário. Também retorna um erro padrão no corpo da resposta e um HTTP status 404 caso o id e o commentId passados na URI não existam.
No corpo da request é passado o comentário atualizado e após a atualização, é retornado um HTTP status 204. Por exemplo,
a request localhost:8080\recipe\639c7dfbbf89243463a2cda6\comment\639fab63b98c514ab6363b96 com request body
{
"comment": "Topzera"
}Irá atualizar o comentário id 639fab63b98c514ab6363b96 da receita id 639c7dfbbf89243463a2cda6 para Topzera. E
retornar HTTP status 404 após isso.
Utilizado para deletar um comentário de uma receita e se tudo der certo, um HTTP status 204 é retornado.
Caso o id da receita ou o commentId não existam, também retorna um erro padrão e um HTTP status 404.
- Java versão 11
- Maven versão 3.8.6
- MongoDB versão 6.0
- Javalin versão 5.2