Biblioteca Online - API REST

🚧 Biblioteca Online 🚧

Sobre • Funcionalidades • Entidade • Como executar • Tecnologias

---

💻 Sobre o projeto

O projeto Biblioteca Online foi desenvolvido após a aula de API REST do curso de Javascript com foco em backend da Cubos Academy. A aplicação fornece um conjunto de funcionalidades para gerenciar uma coleção de livros, permitindo consultas, cadastros, substituições, alterações e remoções.

---

⚙ Funcionalidades

• Consultar Coleção de Livros
• Consultar um Livro através do ID
• Adicionar um novo Livro
• Substituir Livro
• Alterar um Livro Existente
• Remover Livros

---

📘 Entidade

• Livro - Propriedades: id, titulo, autor, ano e numPaginas

---

🛣 Como executar o projeto

Este projeto consiste apenas no Backende e não trabalha com banco de Dados no momento.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Servidor

# Clone este repositório
$ git clone git@github.com:KarlaSilvaEng/biblioteca-online.git

# Acesse a pasta do projeto no terminal/cmd
$ cd biblioteca-online

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

# O servidor inciará na porta:3000 - acesse http://localhost:3000

Utilizando o Insomnia para Acessar as Funcionalidades

Consultar Coleção de Livros

• Método: GET
• Endpoint: '/livros'
• Resposta: Listagem da coleção completa de livros
• Exemplo:

  • URL Completa: http://localhost:3000/livros

  • Resposta:

    

Consultar um Livro através do ID

• Método: GET
• Endpoint: '/livros/:id'
• Resposta: Retorna o objeto livro que corresponde ao id fornecido
• Exemplo:

  • URL Completa: http://localhost:3000/livros/2

  • Resposta:

    

Adicionar um Novo Livro

• Método: POST
• Endpoint: '/livros'
• Corpo da Requisição: Objeto JSON contendo todas as propriedades da entidade livro a ser adicionada à coleção e os seus respectivos valores
• Resposta: Retorna o objeto livro criado.
• Exemplo:

  • URL Completa: http://localhost:3000/livros

  • Corpo da Requisição:

    Corpo da Requisição

  • Resposta:

    

Substituir um Livro Existente

• Método: PUT
• Endpoint: '/livros/:id'
• Corpo da Requisição: Objeto JSON contendo todas as propriedades do objeto livro e seus novos valores
• Resposta: Retorna uma mensagem informando que o livro foi substituído.
• Exemplo:

  • URL Completa: http://localhost:3000/livros/2

  • Corpo da Requisição:

    

  • Resposta:

    

Alterar Parcialmente um Livro Existente

• Método: PATCH
• Endpoint: '/livros/:id'
• Corpo da Requisição: Objeto JSON contendo as propriedades a serem alteradas e seus novos valores
• Resposta: Retorna uma mensagem informando que o livro foi alterado
• Exemplo:

  • URL Completa: http://localhost:3000/livros/1

  • Corpo da Requisição:

    

  • Resposta:

    

Remover um Livro

• Método: DELETE
• Endpoint: '/livros/:id'
• Resposta: Retorna uma mensagem informando que o livro foi removido
• Exemplo:

  • URL Completa: http://localhost:3000/livros/1

  • Resposta:

    

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS

• Express

Veja o arquivo package.json

Utilitários

• Editor: Visual Studio Code
• Markdown: StackEdit, Markdown Emoji
• Teste de API: Insomnia

---

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---