https://github.com/maoruibin/liuye
柳叶清单开放 API 文档
https://github.com/maoruibin/liuye
api-documentation api-rest api-service todolist todos
Last synced: about 2 months ago
JSON representation
柳叶清单开放 API 文档
- Host: GitHub
- URL: https://github.com/maoruibin/liuye
- Owner: maoruibin
- Created: 2019-05-22T15:34:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-02T02:39:26.000Z (over 6 years ago)
- Last Synced: 2025-01-11T23:23:41.565Z (about 1 year ago)
- Topics: api-documentation, api-rest, api-service, todolist, todos
- Homepage: https://gudong.name/list
- Size: 20.5 KB
- Stars: 32
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 柳叶清单
[柳叶清单](http://gudong.name/list)是自己独立开发设计的一个 Web 清单应用，目前网页版已经上线运行，地址如下：
[http://gudong.name/list](http://gudong.name/list)
开发初衷：[柳叶清单：管理日程的网页清单程序](https://gudong.name/2018/06/09/list-evety-day.html)
于此同时，为了方便其他开发者使用清单服务，现在开放了部分 API，**以便大家开发自己的 Todo 应用或者 demo 小程序**。
如果使用中有任何问题，也可以在 [issue](https://github.com/maoruibin/liuye/issue) 中进行反馈。
## 目录
* [API model 关系说明](#api-model-关系说明)
* [用户信息](#用户信息)
* [登录](#登录)
* [注册](#注册)
* [获取用户信息](#获取用户信息)
* [Todo](#todo)
* [创建 todo](#创建-todo)
* [更新 Todo](#更新-todo)
* [删除 Todo](#删除-todo)
* [获取 Todo](#获取-todo)
* [分组 API](#分组-api)
* [创建分组](#创建分组)
* [更新分组](#更新分组)
* [获取项目分组列表](#获取项目分组列表)
* [删除分组](#删除分组)
* [Project 相关 api](#project-相关-api)
* [创建项目](#创建项目)
* [编辑项目](#编辑项目)
* [删除项目](#删除项目)
* [关于作者](#关于作者)
>目录生成 by [github-markdown-toc](https://github.com/ekalinin/github-markdown-toc)
## API model 关系说明
为了对清单 API 有更好的认识，这里先简单说一下具体的数据 model 关系，目前一共有 4 个 model，分别是 User、Project、Group、Todo.
* User: 用户信息
* Project：清单项目，一个用户（User）可以创建多个清单项目。
* Group：分组，一个清单项目（Project）包含多个清单分组
* Todo：事项，每个分组（Group）下有若干 Todo 组成
这个关系用图表示出来如下所示：
上面的示意有点抽象，这里用一个具体的例子进行展示如下：
下面是目前开放出来的所有数据操作相关的 API，包括用户登录、注册，以及事项（Todo）、分组（Group）、项目（Project）数据的操作，如下所示：
-----
## 用户信息
### 登录
```
https://waishuo.leanapp.cn/api/v1.0/users/login
```
> 目前仅支持邮箱登录，暂不支持用户名登录
请求方式：POST
请求参数：
响应结果：
### 注册
```
https://waishuo.leanapp.cn/api/v1.0/users/register
```
请求方式：POST
请求参数：
响应结果：
### 获取用户信息
```
https://waishuo.leanapp.cn/api/v1.0/users/
```
请求方式：GET
> 说明：url 请求参数中最后需要指定 user id
请求参数：
无
响应结果：
-----
## Todo
### 创建 todo
```
https://waishuo.leanapp.cn/api/v1.0/todos
```
请求方式：POST
请求参数：
响应结果：
### 更新 Todo
```
https://waishuo.leanapp.cn/api/v1.0/todos/
```
请求方式：PUT
> 说明：url 请求参数中最后需要指定 todo id
请求参数：
响应结果：
### 删除 Todo
```
https://waishuo.leanapp.cn/api/v1.0/todos/
```
请求方式：DEL
请求参数：
> 说明：url 请求参数中最后需要指定 todo id
响应结果：
### 获取 Todo
```
https://waishuo.leanapp.cn/api/v1.0/todos/
```
请求方式：GET
请求参数：
> 说明：url 请求参数中最后需要指定 todo id
响应结果：
-----
## 分组 API
### 创建分组
```
https://waishuo.leanapp.cn/api/v1.0/groups
```
请求方式：POST
请求参数：
响应结果：
### 更新分组
```
https://waishuo.leanapp.cn/api/v1.0/groups/
```
请求方式：PUT
> 说明：url 请求参数中最后需要指定 groupId
请求参数：
响应结果：
### 获取项目分组列表
```
https://waishuo.leanapp.cn/api/v1.0/groups/projects/
```
请求方式：GET
请求参数：
> 说明：url 请求参数中最后需要指定 projectId
响应结果：
### 删除分组
```
https://waishuo.leanapp.cn/api/v1.0/groups/
```
请求方式：DEL
请求参数：
> 说明：url 请求参数中最后需要指定 groupId
响应结果：
-----
## Project 相关 api
### 创建项目
```
https://waishuo.leanapp.cn/api/v1.0/project
```
请求方式：POST
请求参数：
响应结果：
### 编辑项目
```
https://waishuo.leanapp.cn/api/v1.0/project
```
请求方式：PUT
请求参数：
响应结果：
### 删除项目
```
https://waishuo.leanapp.cn/api/v1.0/projects/
```
> 注意：删除时，会把项目下的分组以及 todo 全部删除
请求方式：DEL
> 说明：url 请求参数中最后需要指定 projectId
## 关于作者
* Android 工程师，[咕咚翻译](https://sspai.com/post/33226)等多款 APP 应用作者。
* 微博：[大侠咕咚](http://weibo.com/maoruibin)
* 个人主页：[咕咚](https://gudong.name/)