{"info":{"_postman_id":"0b2a2015-f169-4419-90e1-7819c1d30ecc","name":"API Catalogo de Livros","description":"

Esta é uma API de catálogo de livros desenvolvida com Django Rest Framework, foi projetada para armazenar informações sobre livros, incluindo nome do livro, nome do autor, ano de lançamento e número da edição.Você também poderá buscar os livros por gênero, nome do autor, nome do livro, tipo ou nome da editora.

🔧 Ferramentas

Python: é uma linguagem de programação de alto nível, interpretada, orientada a objetos e de propósito geral.
Django: framework de desenvolvimento web de código aberto, escrito em Python, que oferece uma estrutura robusta e eficiente para a criação de aplicativos web.
Django Rest Framework: é uma poderosa biblioteca de terceiros para o Django, um framework de desenvolvimento web em Python. O DRF estende a funcionalidade do Django para facilitar a criação de APIs (Application Programming Interfaces) RESTful de maneira eficiente e consistente.

📍 Endpoints

GET /livro/: Retorna a lista de todos os livros no catálogo.
\n
POST /livro/: Cria um novo livro no catálogo.
\n
GET /livro/{id}/: Retorna os detalhes de um livro específico com base no ID.
\n
PUT /livro/{id}/: Atualiza as informações de um livro específico com base no ID.
\n
GET /livro/?search={param}: Retorna os detalhes de livros baseado em parametros que podem ser: genero, nome do autor, nome do livro, editora ou tipo.
\n
DELETE /livro/{id}/: Exclui um livro específico com base no ID.
\n

📄 Modelos de Dados

Livro:
- id (campo automático): O identificador único do livro.
- nome (string): Nome do livro.
- nomeDoAutor (string): Nome do autor do livro.
- lancamento (inteiro): Ano de lançamento da primeira versão do livro.
- numEdicao (inteiro): Número da edição do livro.
- tipo (string): Tipo do livro (livro, mangá, hq...).
- genero (string): Genero do livro.
- editora (string): Nome da editora.
- anoEdicao (inteiro): Ano de lançamento da edição.
- numEdicao (inteiro): Numero da edição.
\n

⚙️ Uso da API

A API pode ser usada para:

Listar todos os livros no catálogo.
\n
Adicionar um novo livro ao catálogo.
\n
Recuperar detalhes de um livro específico com base no ID.
\n
Recupera detalhes de livros com base em seu nome, nome do autor, genero, tipo ou editora
\n
Atualizar informações de um livro existente.
\n
Excluir um livro específico do catálogo.
\n

💻 Como Executar o Projeto

Siga estas etapas para configurar e executar a API em seu ambiente:

git clone https://seurepositorio.git
cd nomedoprojeto/
python -m venv venvsource venv/bin/activate # No Windows, use 'venv\\Scripts\\activate'
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

A API estará acessível em http://localhost:8000/.

🌐 Exemplo de Solicitação

Criar um Novo Livro

  Método: POST\n  URL: http://localhost:8000/livro/\n\n

Corpo da Solicitação:

{\n  \"id\":1,\n  \"nome\": \"Nome do Livro\",\n  \"nomeDoAutor\": \"Nome do Autor\",\n  \"lancamento\": 2023,\n  \"tipo\": \"Livro\",\n  \"genero\": \"Genero do Livro\",\n  \"editora\": \"Editora do Livro\",\n  \"anoEdicao\": 2018,\n  \"numEdicao\": 1\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29576774","collectionId":"0b2a2015-f169-4419-90e1-7819c1d30ecc","publishedId":"2s9YXh73uv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-08T15:04:01.000Z"},"item":[{"name":"GET Livro (TODOS)","id":"36e3b2ac-06b1-4871-b5ba-dc1e35f5476b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/livro/","description":"

Retorna a lista de todos os livros no catálogo.

\n","urlObject":{"protocol":"http","port":"8000","path":["livro",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"36e3b2ac-06b1-4871-b5ba-dc1e35f5476b"},{"name":"GET Livro {id}","id":"52c01651-c179-40d2-9a1f-1c78d454f782","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/livro/7/","description":"

Retorna os detalhes de um livro específico com base no ID.

\n","urlObject":{"protocol":"http","port":"8000","path":["livro","7",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"52c01651-c179-40d2-9a1f-1c78d454f782"},{"name":"POST Livro (Body)","id":"eafb3f97-35df-4c9a-bf0b-d16cc2a049e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"nome","value":"V de Vingança","type":"text"},{"key":"nomeDoAutor","value":"Alan Moore","type":"text"},{"key":"lancamento","value":"1982","type":"text"},{"key":"tipo","value":"HQ","type":"text"},{"key":"genero","value":"Graphic Novel","type":"text"},{"key":"editora","value":"Panini","type":"text"},{"key":"anoEdicao","value":"2018","type":"text"},{"key":"numEdicao","value":"1","type":"text"}]},"url":"http://127.0.0.1:8000/livro/?nome=V de Vingança&nomeDoAutor=Alan Moore&anoDeLançamento=1982&tipo=HQ&genero=Graphic Novel&editora=Panini&anoEdicao=2018&numEdicao=1","description":"

Cria um novo livro no catálogo.

\n","urlObject":{"protocol":"http","port":"8000","path":["livro",""],"host":["127","0","0","1"],"query":[{"key":"nome","value":"V de Vingança"},{"key":"nomeDoAutor","value":"Alan Moore"},{"key":"anoDeLançamento","value":"1982"},{"key":"tipo","value":"HQ"},{"key":"genero","value":"Graphic Novel"},{"key":"editora","value":"Panini"},{"key":"anoEdicao","value":"2018"},{"key":"numEdicao","value":"1"}],"variable":[]}},"response":[],"_postman_id":"eafb3f97-35df-4c9a-bf0b-d16cc2a049e2"},{"name":"GET Livro ?search=","id":"5897cc31-9818-4827-8e02-b7701570963e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/livro/?search=Romance","description":"

Exclui um livro específico com base no ID.

\n","urlObject":{"protocol":"http","port":"8000","path":["livro",""],"host":["127","0","0","1"],"query":[{"key":"search","value":"Romance"}],"variable":[]}},"response":[],"_postman_id":"5897cc31-9818-4827-8e02-b7701570963e"},{"name":"PUT Livro (Body)","id":"248af9d2-d1b8-4b59-970f-3dcb3fea4224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"nome","value":"V de Vingança","type":"text"},{"key":"nomeDoAutor","value":"Alan Moore","type":"text"},{"key":"lancamento","value":"1982","type":"text"},{"key":"tipo","value":"HQ","type":"text"},{"key":"genero","value":"Graphic Novel","type":"text"},{"key":"editora","value":"Panini","type":"text"},{"key":"anoEdicao","value":"2018","type":"text"},{"key":"numEdicao","value":"1","type":"text"}]},"url":"http://127.0.0.1:8000/livro/7/","description":"

Atualiza as informações de um livro específico com base no ID.

Exclui um livro específico com base no ID.

\n","urlObject":{"protocol":"http","port":"8000","path":["livro","4",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa340346-6e59-4bb1-8700-cd81067e24c3"}]}