Projeto consiste na criação de uma api para uma biblioteca, onde os livros serão cadastrados, atualizados e deletados.
Cada livro terá uma categoria associada, onde para cadastrar um livro deverá preexistir uma categoria para o mesmo.
Após excutado o projeto localmente, para ver a documentação acesse: swagger
-
[GET] consultar todos os livros: {url}/book/books
-
[GET] consultar 1 livro especifico, passar id por parametro na requisição: {url}/book/{id}
-
[GET] consultar livros por categoria, passar id de categoria query ex: {url}/book?category=1
-
[POST] criar Livro, passar id de categoria no corpo da requisição: {url}/book/create
{
"title": "type string",
"author": "type string",
"text": "type string",
"categoryId": "type long",
}
- [PutORPatch] atualizar Livro, passar id do livro por parametro da requisição: {url}/book/update/{id}
{
"title": "type string",
"author": "type string",
"text": "type string",
}
- [DELETE] deletar Livro, passar id do livro por parametro da requisição: {url}/book/delete/{id}
-
[GET] consultar todas as categorias: {url}/category/categories
-
[GET] consultar 1 categoria especifica, passar id por parametro na requisição: {url}/category/{id}
-
[GET] consultar categoria, sem retornar lista de livros: {url}/category
-
[POST] criar Categoria: {url}/category/create
{
"name": "type string",
"description": "type string",
}
- [Put] atualizar Categoria, passar id da Categoria parametro da requisição: {url}/category/update/{id}
{
"name": "type string",
"description": "type string",
}
- [DELETE] deletar Categoria, passar id da categoria parametro da requisição: {url}/category/delete/{id}
-
Para clonar o projeto: git clone https://github.com/TaylanTorres09/book-store-api.git
-
Para Executar o projeto precisasse:
-
Extensões do vscode utilizadas:
-
Para seleção do perfil test para perfil de teste e dev para perfil de desenvolvimento.
-
Configuração do banco de dados de Teste.
- Configuração do banco de dados de Dev.
- Na pasta src/main, execute o arquivo BookstoreApplication.java
- Após executado o projeto acesse swagger para ver documentação.
- Para testar a api você pode utilizar ferramentas de client como:
- Postman
- Insomnia
- Extensão do VsCode Thunder Client
- Ou outra de sua preferência.
- Fazer interfaces no front-end.
- Implementar Cobertura de testes.