# 九月的柿子

**Repository Path**: wen-simin/september-persimmon

## Basic Information

- **Project Name**: 九月的柿子
- **Description**: 九月的柿子
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-11
- **Last Updated**: 2022-04-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 代办列表应用参考






## 路由以及功能        

1. 用户注册功能       

```javascript
{
    path: '/register',
    method: 'POST',
    data:{
        username: String,
        password: String,
        confirmPassword: String,
        nickname: String
    },
    result: {
        success: Boolean,
        message: String,
        user: User
    }
}

```

2. 用户登录

```javascript
{
    path: '/login',
    method: 'POST',
    data: {
        username: String,
        password: String
    },
    result: {
        success: Boolean,
        message: String,
        errors: {
            username: [String, ...],
            ...
        }
    }
}

```

3. 用户退出
```javascript
{
    path: '/logout',
    method: 'GET',
    result: {
        success: Boolean,
        message: String
    }
}
```

4. 获取用户代办列表

```javascript
{
    path: '/todos',
    method: 'GET',
    params: {
        days: Number,
        priority: String,
        isFinished: String,
        limit: Number,
        offset: Number
    },
    result: {
        success: Boolean,
        message: String,
        query: {
            count: Number,
            limit: Number,
            offset: Number,
            page: Number,
            results: [ Todo, ...]
        }
    }
}
```

5. 添加新代办

```javascript

{
    path: '/todos',
    method: 'POST',
    data: {
        title: String,
        description: String,
        priority: String
    },
    result: {
        success: Boolean,
        message: String,
        todo: Todo
        }

}
normal | important | crucial
```

6. 修改代办信息

```javascript
{
    path: '/todos/:tid',
    method: 'PUT',
    data: {
        title: String,
        description: String,
        priority: String
    },
    result: {
        success: Boolean,
        message: String,
        todo: Todo
        }

}

```

7. 删除代办

```javascript
{
    path: '/todos/:tid',
    method: 'DELETE',
    result: {
        success: Boolean,
        message: String,
        todo: Todo
        }


}
```


8. 完成代办

```javascript
{
    path: '/todos/finish/:tid',
    method: 'PUT',
    result: {
        success: Boolean,
        message: String,
        todo: Todo
    }
    
}
```

9. 统计代办完成情况

```javascript
{
    path: '/todos/start',
    method: 'GET',
    result: {
        success: true,
        query: {
            count: Number,
            finished: [{
                priority: String,
                count: Number
            }, ...],
            notFinish: [{
                priority: String,
                count: Number
            }, ...]
        }
    }
}
```
10. 查询用户登录信息

```javascript
{
    path: '/user/info', 
    method: 'GET',
    result: {
        success: Boolean,
        user: User
        }
}
```

11. 修改用户密码

```javascript
{
    path: "/user/changePassword",
    method: "PUT",
    data:{
        oldPassword: string,
        password: string,
        confirPassword: string,
    },
    result:{
        success: Boolean,
        message: string,
    }





}


```