Giter Club home page Giter Club logo

flask-task-api's Introduction

Flask Task API

API de gerenciamento de tarefas com Flask, operações CRUD e testes automatizados com pytest.

Funcionalidade:

  • Adicionar tarefas com titulo, descrição, status (concluída ou não).
  • Buscar todas as tarefas ou uma específica por ID.
  • Atualizar tarefas.
  • Deletar tarefas.

Como Executar a Aplicação

  1. Certifique-se de ter o Python instalado.

  2. Clone este repositório:

git clone https://github.com/devnatanaelsantos/flask-task-api.git
  1. Pelo terminal, acesse o diretório do projeto.

  2. Instale as dependências:

pip install -r requirements.txt
  1. Execute a aplicação:
python app.py

Como Executar os Testes Automatizados

  1. Com a aplicação em execução, abra um novo terminal, acesse o diretório do projeto e execute o comando:
pytest tests.py -v

Os testes automatizados serão executados e os resultados serão exibidos no terminal.

Testando os Endpoints no Postman

Recomendo testar os endpoints da API usando o Postman. Aqui estão as instruções para cada endpoint:

Criar uma tarefa

Método: POST

URL: http://127.0.0.1:5000/tasks

Corpo da Requisição (JSON):

{
    "title": "Nova Tarefa",
    "description": "Descrição da nova tarefa"
}

Retorno esperado:

{
    "id": 1,
    "message": "Nova tarefa criada com sucesso"
}

Obter todas as tarefas

Método: GET

URL: http://127.0.0.1:5000/tasks

Retorno esperado:

{
    "tasks": [
        {
            "completed": false,
            "description": "Descrição da nova tarefa",
            "id": 1,
            "title": "Nova Tarefa"
        }
    ],
    "total_tasks": 1
}

Obter uma tarefa específica

Método: GET

URL: http://127.0.0.1:5000/tasks/{id} Substitua '{id}' pelo ID da tarefa desejada.

Retorno esperado:

        {
            "completed": false,
            "description": "Descrição da nova tarefa",
            "id": 1,
            "title": "Nova Tarefa"
        }

Atualizar uma tarefa

Método: PUT

URL: http://127.0.0.1:5000/tasks/{id}Substitua {id} pelo ID da tarefa a ser atualizada.

Corpo da Requisição (JSON):

{
    "title": "Título atualizado",
    "description": "Descrição atualizada",
    "completed": true
}

Retorno esperado:

{
    "message": "Tarefa atualizada com sucesso"
}

Deletar uma tarefa

Método: DELETE

URL: http://127.0.0.1:5000/tasks/{id}Substitua {id} pelo ID da tarefa a ser deletada.

Retorno esperado:

{
    "message": "Tarefa deletada com sucesso"
}

flask-task-api's People

Contributors

devnatanaelsantos avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.