https://github.com/0taviopascoal/bookstore-api

Projeto de uma Livraria feita com Java Spring Boot com conexão ao banco de dados, segurança com JWT e etc...
https://github.com/0taviopascoal/bookstore-api

java jpa jwt-token postgresql spring-boot

Last synced: about 1 year ago
JSON representation

Projeto de uma Livraria feita com Java Spring Boot com conexão ao banco de dados, segurança com JWT e etc...

Host: GitHub
URL: https://github.com/0taviopascoal/bookstore-api
Owner: 0tavioPascoal
License: mit
Created: 2024-11-08T13:00:13.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2025-01-03T13:53:15.000Z (over 1 year ago)
Last Synced: 2025-03-30T23:31:33.630Z (over 1 year ago)
Topics: java, jpa, jwt-token, postgresql, spring-boot
Language: Java
Homepage:
Size: 118 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

          # BookStore-API

## Docker

Para usar o docker utilizar o comando a seguir no terminal da própria idea ->

```Docker

 $ docker compose up

```

Para derrubar o container do docker utilizar o comando a seguir no terminal da própria idea ->

```Docker

 $ docker compose down

```

## Documentação da API

### Autenticação

- Rotas para autenticação na aplicação, sendo possivel registrar um novo usuario e logar na aplicação, resultando em um token que deverá ser usado em todos os request.

##

``http

  POST /auth/register

``

| Corpo   | Tipo       | Descrição                           |

| :---------- | :--------- | :---------------------------------- |

| `login` | `string` | **Obrigatório**. E-mail para login na aplicação.  |

| `password` | `string` | **Obrigatório**. Senha para login na aplicação. |

| `email` | `string` | **Obrigatório**. E-mail. |

| `username` | `string` | **Obrigatório**. Definir um nome de usuário. |

| `role` | `string` | Tipo de usuário. *Admin* ou *User* |

##

``http

  POST /auth/login

``

| Corpo   | Tipo       | Descrição                           |

| :---------- | :--------- | :---------------------------------- |

| `login` | `string` | **Obrigatório**. E-mail para login na aplicação.  |

| `password` | `string` | **Obrigatório**. Senha para login na aplicação. |

### Usuários.

- Rotas para Modificação, exclusão e listagem de usuários.

##

``http

  GET /users

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `size`      | `integer` | Tamanho de itens na pagina. |

| `page`      | `integer` | Número da pagina. |

| `username`      | `string` | Nome do Usuário. |

| `login`      | `String` | Login do Usuário. |

##

``http

  GET /users

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Usuário. |

##

``http

  DEL /users

``

- Somente Admins.

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Usuário. |

##

``http

  PUT /authors

``

- Somente Admins.

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Usuário. |

| Corpo   | Tipo       | Descrição                           |

| :---------- | :--------- | :---------------------------------- |

| `login` | `string` | **Obrigatório**. E-mail para login na aplicação.  |

| `password` | `string` | **Obrigatório**. Senha para login na aplicação. |

| `email` | `string` | **Obrigatório**. E-mail. |

| `username` | `string` | **Obrigatório**. Definir um nome de usuário. |

| `role` | `string` | Tipo de usuário. *Admin* ou *User* |

### Autores

- Rotas para criação, alteração e deleção de Autores na aplicação.

- Para criar Autores e deletar apenas Admins

##

``http

  GET /authors

``

- Busca todos os autores com o nome ou nacionalidade passada por parâmetro.

  

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `name`      | `string` | Autores com esse nome ou letra. |

| `nacionality`| `string` | Autores com a nacionalidade. |

##

``http

  GET /authors/

``

- Busca Autor por id.

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do autor. |

##

``http

  POST /authors

``

- Somente Admins.

| Corpo         | Tipo       | Descrição                                   |

| :----------   | :--------- | :------------------------------------------ |

| `name`        | `string` | **Obrigatório** nome do Autor. |

| `dateOfBirth` | `date` | **Obrigatório** Obrigatorio a data de nascimento do Autor. |

| `nationality`   | `string` | **Obrigatório** Nacionalidade do Autor. |

##

``http

  PUT /authors

``

- Somente Admins.

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do autor. |

| Corpo         | Tipo       | Descrição                                   |

| :----------   | :--------- | :------------------------------------------ |

| `name`        | `string` | **Obrigatório** nome do Autor. |

| `dateOfBirth` | `date` | **Obrigatório** Obrigatorio a data de nascimento do Autor. |

| `nationality`   | `string` | **Obrigatório** Nacionalidade do Autor. |

##

``http

  DEL /authors

``

- Somente Admins.

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Autor. |

### Livros

- Rotas para criação de Livros.

##

``http

  GET /books

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `size`      | `integer` | Tamanho de itens na pagina. |

| `page`      | `integer` | Número da pagina. |

| `title`      | `string` | Titulo do livro. |

| `price`      | `bigDecimal` | Preço do livro. |

| `gender`      | `string` | Genero do livro -> (Romance, Aventura e etc...). |

| `publicationDate`      | `Date` | Data da publicação do livro. |

| `nameAuthor`      | `String` | Nome do Autor do livro. |

##

``http

  GET /books

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Livro. |

##

``http

  POST /books

``

| Corpo         | Tipo       | Descrição                                   |

| :----------   | :--------- | :------------------------------------------ |

| `title`    | `string`  | **Obrigatório** . |

| `publicationDate`   | `LocalDate`   | **Obrigatório** Data da publicação do Livro. |

| `gender`   | `string`   | **Obrigatório** Genero do livro. |

| `price`   | `bigDecimal`   | **Obrigatório** Preço do livro. |

| `idAuthor`   | `string`   | **Obrigatório** Id do Autor para cadastrar o Livro. |

##

``http

  DEL /books

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Livro. |

##

``http

  PUT /books

``

| Parâmetro   | Tipo       | Descrição                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Obrigatório** Id do Livro. |

| Corpo         | Tipo       | Descrição                                   |

| :----------   | :--------- | :------------------------------------------ |

| `title`    | `string`  | **Obrigatório** . |

| `publicationDate`   | `LocalDate`   | **Obrigatório** Data da publicação do Livro. |

| `gender`   | `string`   | **Obrigatório** Genero do livro. |

| `price`   | `bigDecimal`   | **Obrigatório** Preço do livro. |

| `idAuthor`   | `string`   | **Obrigatório** Id do Autor para cadastrar o Livro. |

## Autor

- [@OtavioPascoal](https://github.com/0tavioPascoal)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/0taviopascoal/bookstore-api

Awesome Lists containing this project

README