Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oqapzin/livraria-api
Api de livros utilizando node, express e mongodb. Desenvolvida na formanção API com NodeJS da Alura.
https://github.com/oqapzin/livraria-api
express mongodb mongoose nodejs
Last synced: 24 days ago
JSON representation
Api de livros utilizando node, express e mongodb. Desenvolvida na formanção API com NodeJS da Alura.
- Host: GitHub
- URL: https://github.com/oqapzin/livraria-api
- Owner: oqapzin
- Created: 2024-10-14T23:14:17.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-15T16:07:09.000Z (about 1 month ago)
- Last Synced: 2024-10-16T20:56:36.092Z (about 1 month ago)
- Topics: express, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 5.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# backend-api-livros
Api de livros utilizando node, express e mongodb. Desenvolvida na formação API com NodeJS da Alura.
## ✏️ Descrição
> Este projeto tem como objetivo demonstrar os conhecimentos adquiridos durante o curso introdutório de criação de APIs com Node e Express.
## 💻 Tecnologias utilizadas
* Node
* Express
* Mongo
* Mongoose
* Nodemon
## 🚀 Instalação
1. Clone o repositório:
```
git clone https://github.com/oqapzin/backend-api-livros
```
2. Navegue até o diretório do projeto:
```
cd backend-api-livros
```
3. Instale as dependências:
```
npm install
```
4. Após a conclusão da instalação, inicie o servidor de desenvolvimento:
```
npm run dev
```
# 🔧 Configuração
Antes de executar o projeto, é necessário renomear o arquivo `env copy` para `.env` e configurá-lo com as variáveis de ambiente necessárias. Veja um exemplo de arquivo `.env`:
- MONGO_DB_USER=seu_usuario
- MONGO_DB_PASSWORD=sua_senha
- MONGO_DB_ADDRESS=seu_endereço_do_mongodb
- API_PORT=porta_desejada
## 📃 Rotas/API
### Autores
- `GET /autores`: Retorna uma lista de todos os autores.
- `GET /autores/:id`: Retorna os detalhes de um autor específico.
- `POST /autores`: Cria um novo autor.
- `PUT /autores/:id`: Atualiza as informações de um autor específico.
- `DELETE /autores/:id`: Remove um autor específico.
### Livros
- `GET /livros`: Retorna uma lista de todos os livros.
- `GET /livros/busca`: Retorna uma lista de livros filtrada por editora.
- `GET /livros/:id`: Retorna os detalhes de um livro específico.
- `POST /livros`: Cria um novo livro.
- `PUT /livros/:id`: Atualiza as informações de um livro específico.
- `DELETE /livros/:id`: Remove um livro específico.