Documentação da API de Gerenciamento de Livros

Bem-vindo à API de Gerenciamento de Livros. Esta API permite gerenciar uma coleção de livros, adicionar novos livros.

🪧 Vitrine.Dev
✨ Nome	BOOKSTORE
🏷️ Tecnologias	Nodejs, Express, Sequelize ORM, Mysql
🚀 URL	https://github.com/higorbeleza/project-bookstore
🔥 Desafio

Base da url

https://localhost:4000

Endpoints

• Listar Livros

Endpoint: /book

Método: GET

Descrição: Retorna uma lista de todos os livros cadastrados no sistema.

Exemplo de resposta:

Status: 200 OK
[
  {
    "id": 1,
    "titulo": "O Pequeno Príncipe",
    "autor": "Antoine de Saint-Exupéry",
    "ano": 1943
  },
  {
    "id": 2,
    "titulo": "Harry Potter e a Pedra Filosofal",
    "autor": "J.K. Rowling",
    "ano": 1997
  },
]

• Obter Detalhes de um Livro

  Endpoint: /book/:id

Método: GET

Descrição: Retorna os detalhes de um livro específico com base no ID fornecido.

Parâmetros de URL:

:id (number): O ID do livro a ser recuperado.

Exemplo de resposta para /livros/1:

Status: 200 OK
{
  "id": 1,
  "titulo": "O Pequeno Príncipe",
  "autor": "Antoine de Saint-Exupéry",
  "ano": 1943
}

• Adicionar Novo Livro

Endpoint: /book

Método: POST

Descrição: Adiciona um novo livro à coleção.

Parâmetros de requisição:

{
  "titulo": "Novo Livro",
  "autor": "Autor Desconhecido",
  "ano": 2023
}

Exemplo de resposta para uma requisição válida:

Status: 201 Created
{
  "id": 3,
  "titulo": "Novo Livro",
  "autor": "Autor Desconhecido",
  "ano": 2023
}

• Atualizar Informações do Livro

  Endpoint: /book/:id

Método: PUT

Descrição: Atualiza as informações de um livro específico com base no ID fornecido.

Parâmetros de URL:

:id (number): O ID do livro a ser atualizado.

Parâmetros de requisição:

{
  "titulo": "Novo Título",
  "autor": "Autor Atualizado",
  "ano": 2021
}

Exemplo de resposta para uma requisição válida:

Status: 200 OK
{
  "id": 3,
  "titulo": "Novo Título",
  "autor": "Autor Atualizado",
  "ano": 2021
}

• Remover Livro

Endpoint: /book/:id

Método: DELETE

Descrição: Remove um livro específico com base no ID fornecido.

Parâmetros de URL:

:id (number): O ID do livro a ser removido.

Nota

• Para realizar operações de criação, atualização e remoção de livros, é necessária autenticação utilizando um token de acesso válido. Essa é uma versão simplificada de uma documentação de API para gerenciamento de livros. Uma documentação real seria mais detalhada e abrangente, incluindo informações sobre autenticação, códigos de erro, limites de taxa e outros detalhes importantes para os usuários da API. Lembre-se de que a documentação deve ser clara e precisa, facilitando o uso da API pelos desenvolvedores.