/Python_Flask_Biblioteca

API rest criada em python flask com intuito de simular o sistema CRUD de uma livraria

Primary LanguagePython

Documentaçao da API livraria

A API Livraria é uma aplicação Flask que permite gerenciar uma coleção de livros em um banco de dados. Você pode realizar operações CRUD (Create, Read, Update, Delete) nos livros da livraria usando esta API.

Endpoints da API

1. Listar Todos os Livros

Endpoint: /livraria Método HTTP: GET

Este endpoint permite listar todos os livros disponíveis na livraria.

Exemplo de Solicitação:

GET http://lucena2307.pythonanywhere.com/livraria

Exemplo de Resposta:

{
    "id": 1,
    "titulo": "O Senhor dos Anéis",
    "autor": "J.R.R. Tolkien",
    "num_paginas": 1178,
    "custo": 29.99
},
{
    "id": 2,
    "titulo": "Dom Quixote",
    "autor": "Miguel de Cervantes",
    "num_paginas": 863,
    "custo": 19.99
}

2. Listar um Livro por ID

Endpoint: /livraria/ Método HTTP: GET

Este endpoint permite listar um livro específico pelo seu ID.

Exemplo de Solicitação:

GET http://lucena2307.pythonanywhere.com/livraria/1

Exemplo de Resposta:

{ "id": 1, "titulo": "O Senhor dos Anéis", "autor": "J.R.R. Tolkien", "num_paginas": 1178, "custo": 29.99 }

3. Adicionar um Novo Livro

Endpoint: /livraria/add Método HTTP: POST

Este endpoint permite adicionar um novo livro à livraria.

Exemplo de Solicitação:

POST http://lucena2307.pythonanywhere.com/livraria/add

Content-Type: application/json

{ "titulo": "Harry Potter e a Pedra Filosofal", "autor": "J.K. Rowling", "num_paginas": 320, "custo": 24.99 }

Exemplo de Resposta:

{ "Message": "Seu livro foi adicionado com sucesso" }

4. Atualizar um Livro Existente

Endpoint: /livraria/atualizar/ Método HTTP: PUT

Este endpoint permite atualizar as informações de um livro existente com base no seu ID.

Exemplo de Solicitação:

PUT http://lucena2307.pythonanywhere.com/livraria/atualizar/1 Content-Type: application/json

{ "titulo": "O Senhor dos Anéis: A Sociedade do Anel" }

Exemplo de Resposta:

{ "Message": "Livro atualizado com sucesso" }

5. Excluir um Livro

Endpoint: /livraria/delete/ Método HTTP: DELETE

Este endpoint permite excluir um livro da livraria com base no seu ID.

Exemplo de Solicitação:

DELETE http://lucena2307.pythonanywhere.com/livraria/delete/1

Exemplo de Resposta:

{ "Message": "Livro excluído com sucesso" }

Erros e Mensagens

A API retorna mensagens de erro apropriadas em caso de problemas. Os principais erros possíveis incluem:

400 Bad Request: Campos obrigatórios faltando ou dados inválidos na solicitação. 404 Not Found: Livro não encontrado com base no ID fornecido. 500 Internal Server Error: Erro interno do servidor ao executar uma operação.

Considerações Finais

Esta é uma documentação básica da API Livraria, que fornece operações CRUD para gerenciar livros em uma livraria. Você pode estender esta documentação com informações adicionais, como autenticação, autorização, validações e exemplos detalhados de solicitações e respostas, conforme necessário para o seu projeto. Certifique-se de configurar corretamente seu ambiente de desenvolvimento e banco de dados antes de usar a API.