https://github.com/matheusfd3/tasks-flask-crud

Projeto de uma API RESTful simples construída com Flask e testes automatizados.
https://github.com/matheusfd3/tasks-flask-crud

api flask pytest python

Last synced: 6 days ago
JSON representation

Projeto de uma API RESTful simples construída com Flask e testes automatizados.

• Host: GitHub
• URL: https://github.com/matheusfd3/tasks-flask-crud
• Owner: matheusfd3
• Created: 2024-11-06T20:20:59.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T23:27:59.000Z (2 months ago)
• Last Synced: 2024-11-16T23:21:18.140Z (about 2 months ago)
• Topics: api, flask, pytest, python
• Language: Python
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tasks-flask-crud

Este é um projeto de uma API RESTful básica construída com Flask para gerenciar tarefas. A API permite realizar operações CRUD (Criar, Ler, Atualizar e Deletar) em tarefas, sendo ideal para estudos e como exemplo para uma estrutura simples de API. O projeto também inclui testes automatizados usando o `pytest` para garantir a qualidade e a integridade das funcionalidades implementadas.

## Funcionalidades

A API `tasks-flask-crud` oferece os seguintes endpoints para gerenciar tarefas:

- **Criar uma nova tarefa**: Adiciona uma tarefa com título e descrição.

- **Listar todas as tarefas**: Retorna uma lista de todas as tarefas.

- **Visualizar uma tarefa específica**: Retorna os detalhes de uma tarefa pelo seu ID.

- **Atualizar uma tarefa**: Permite modificar o título e/ou descrição de uma tarefa existente.

- **Deletar uma tarefa**: Remove uma tarefa pelo ID.

## Tecnologias Utilizadas

- **Flask**: Framework para criação da API.

- **Pytest**: Framework de testes para automação dos testes da API.

## Instalação

1. **Clone o repositório**:

   ```bash

   git clone https://github.com/matheusfd3/tasks-flask-crud.git

   

   cd tasks-flask-crud

   ```

2. **Instale as dependências:**:

    ```bash

    pip install -r requirements.txt

    ```

3. **Inicie o servidor:**

    ```bash

    python run.py

    ```

## Endpoints

Você pode testar esses endpoints usando o [Postman](https://www.postman.com/) ou outra ferramenta de sua preferência.

| Método | Endpoint           | Descrição                       |

|--------|---------------------|---------------------------------|

| POST   | `/tasks`           | Cria uma nova tarefa           |

| GET    | `/tasks`           | Retorna todas as tarefas       |

| GET    | `/tasks/`      | Retorna uma tarefa específica  |

| PUT    | `/tasks/`      | Atualiza uma tarefa existente  |

| DELETE | `/tasks/`      | Deleta uma tarefa              |

## Testes Automatizados

Os testes automatizados foram implementados com o pytest.

```bash

pytest tests.py -v

```