# todo

**Repository Path**: Flask-devops/todo

## Basic Information

- **Project Name**: todo
- **Description**: todo 一个简单的CRUD单页项目 API
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-11-03
- **Last Updated**: 2025-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# todo


## 安装依赖

```shell
# 安装依赖
pip install -r requirements.txt
```

## 配置.env

```shell
FLASK_APP=main.py
FLASK_CONFIG = 'development'
DB_HOST = 'localhost'
DB_PORT = 3306
DB_USER = 'root'
DB_PASSWORD = '123456'
DATABASE = 'todo'
```

## 初始化数据库

```shell
# 添加数据库迁移支持
flask db init
# 自动创建迁移脚本
flask db migrate -m "initial migration"
# 更新数据库
flask db upgrade
```

## 运行
```shell
# 运行程序
# flask run 
flask run -h 0.0.0.0 -p 5000
```


这里的后端服务选用的是Python的Flask框架，并结合RESTful的组件来开发RESTful风格的接口。

需要开发的后端接口情况如表

| 接口路径              | 接口方法 | 接口说明 |
|-------------------|------|------|
| /api/v1/tasks     | GET | 获取所有todo |
| /api/v1/tasks     | POST | 新增todo |
| /api/v1/tasks/{id} | GET | 获取单个todo |
| /api/v1/tasks/{id} | PUT | 更新单个todo |
| /api/v1/tasks/{id} | DELETE | 删除单个todo |



```shell
# 获取所有todo
curl --location --request GET 'http://127.0.0.1:5000/api/v1/tasks'

# 新增todo
curl --location  POST 'http://127.0.0.1:5000/api/v1/tasks' --header 'Content-Type: application/json' --data-raw '{
  "name": "任务1",
  "desc": "这是一个测试任务", 
  "start_date": "2023-03-01",
  "start_time": "09:00:00",
  "end_date": "2023-03-05",
  "end_time": "18:00:00",
  "assign": "张三",
  "status": "INIT" 
}'

# 更新单个todo
curl --location --request PUT 'http://127.0.0.1:5000/api/v1/tasks/1' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "任务1",
  "desc": "这是一个测试任务1", 
  "assign": "张三1号",
  "status": "INIT" 
}'

# 删除todo
curl --location --request DELETE 'http://127.0.0.1:5000/api/v1/tasks/1'


# 获取单个todo
curl --location --request GET 'http://127.0.0.1:5000/api/v1/tasks/1'
```