{"id":19915782,"url":"https://github.com/maoruibin/liuye","last_synced_at":"2026-03-05T12:02:24.202Z","repository":{"id":91596701,"uuid":"188067083","full_name":"maoruibin/liuye","owner":"maoruibin","description":"柳叶清单开放 API 文档","archived":false,"fork":false,"pushed_at":"2019-07-02T02:39:26.000Z","size":21,"stargazers_count":32,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-28T16:22:26.850Z","etag":null,"topics":["api-documentation","api-rest","api-service","todolist","todos"],"latest_commit_sha":null,"homepage":"https://gudong.name/list","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maoruibin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-22T15:34:34.000Z","updated_at":"2024-04-19T15:59:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"91e16ac2-deb7-4cfe-915f-62aadd51a796","html_url":"https://github.com/maoruibin/liuye","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maoruibin/liuye","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoruibin%2Fliuye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoruibin%2Fliuye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoruibin%2Fliuye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoruibin%2Fliuye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maoruibin","download_url":"https://codeload.github.com/maoruibin/liuye/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoruibin%2Fliuye/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30123731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T11:11:57.947Z","status":"ssl_error","status_checked_at":"2026-03-05T11:11:29.001Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","api-rest","api-service","todolist","todos"],"created_at":"2024-11-12T21:42:24.181Z","updated_at":"2026-03-05T12:02:24.179Z","avatar_url":"https://github.com/maoruibin.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# 柳叶清单\n\n![list](http://upload-images.jianshu.io/upload_images/588640-fa6dc005e8614404.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)\n\n[柳叶清单](http://gudong.name/list)是自己独立开发设计的一个 Web 清单应用，目前网页版已经上线运行，地址如下：\n\n[http://gudong.name/list](http://gudong.name/list)\n\n开发初衷：[柳叶清单：管理日程的网页清单程序](https://gudong.name/2018/06/09/list-evety-day.html)\n\n于此同时，为了方便其他开发者使用清单服务，现在开放了部分 API，**以便大家开发自己的 Todo 应用或者 demo 小程序**。\n\n如果使用中有任何问题，也可以在 [issue](https://github.com/maoruibin/liuye/issue) 中进行反馈。\n\n## 目录\n* [API model 关系说明](#api-model-关系说明)\n* [用户信息](#用户信息)\n    * [登录](#登录)\n    * [注册](#注册)\n    * [获取用户信息](#获取用户信息)\n* [Todo](#todo)\n    * [创建 todo](#创建-todo)\n    * [更新 Todo](#更新-todo)\n    * [删除 Todo](#删除-todo)\n    * [获取 Todo](#获取-todo)\n* [分组 API](#分组-api)\n    * [创建分组](#创建分组)\n    * [更新分组](#更新分组)\n    * [获取项目分组列表](#获取项目分组列表)\n    * [删除分组](#删除分组)\n* [Project 相关 api](#project-相关-api)\n    * [创建项目](#创建项目)\n    * [编辑项目](#编辑项目)\n    * [删除项目](#删除项目)\n\n* [关于作者](#关于作者)    \n\n\u003e目录生成 by [github-markdown-toc](https://github.com/ekalinin/github-markdown-toc)\n\n## API model 关系说明\n\n为了对清单 API 有更好的认识，这里先简单说一下具体的数据 model 关系，目前一共有 4 个 model，分别是 User、Project、Group、Todo.\n\n* User: 用户信息\n* Project：清单项目，一个用户（User）可以创建多个清单项目。\n* Group：分组，一个清单项目（Project）包含多个清单分组\n* Todo：事项，每个分组（Group）下有若干 Todo 组成\n\n这个关系用图表示出来如下所示：\n\n![](https://ws3.sinaimg.cn/large/006tNbRwly1fv2i1id2gtj316m0heaa9.jpg)\n\n上面的示意有点抽象，这里用一个具体的例子进行展示如下：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv2i15reybj31cw0ok3z8.jpg)\n\n下面是目前开放出来的所有数据操作相关的 API，包括用户登录、注册，以及事项（Todo）、分组（Group）、项目（Project）数据的操作，如下所示：\n\n-----\n\n## 用户信息\n\n### 登录\n```\nhttps://waishuo.leanapp.cn/api/v1.0/users/login\n```\n\n\u003e 目前仅支持邮箱登录，暂不支持用户名登录\n\n请求方式：POST \n\n请求参数：\n\n![](https://ws3.sinaimg.cn/large/0069RVTdly1fv122pzfs4j30np02na9x.jpg)\n\n响应结果：\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv249o3de2j31dw0pu0uv.jpg)\n\n### 注册\n```\nhttps://waishuo.leanapp.cn/api/v1.0/users/register\n```\n\n请求方式：POST \n\n请求参数：\n![](https://ws1.sinaimg.cn/large/0069RVTdly1fv125ajg0ij30nu03ia9z.jpg)\n\n响应结果：\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv24kj4l6nj31do0ouwgj.jpg)\n\n### 获取用户信息\n```\nhttps://waishuo.leanapp.cn/api/v1.0/users/\u003cuserId\u003e\n```\n\n请求方式：GET \n\n\u003e  说明：url 请求参数中最后需要指定 user id\n\n请求参数：\n\n无\n\n\n响应结果：\n![](https://ws4.sinaimg.cn/large/006tNbRwly1fv24s4zezxj31di0fgjsg.jpg)\n\n-----\n## Todo \n\n### 创建 todo\n```\nhttps://waishuo.leanapp.cn/api/v1.0/todos\n```\n\n请求方式：POST \n\n请求参数：\n\n![](https://ws4.sinaimg.cn/large/006tNbRwly1fv2gqi0bulj31bc0damxw.jpg)\n\n响应结果：\n\n![](https://ws2.sinaimg.cn/large/006tNbRwly1fv2abvicb4j31e00icjsm.jpg)\n\n\n### 更新 Todo\n```\nhttps://waishuo.leanapp.cn/api/v1.0/todos/\u003ctodoId\u003e\n```\n\n请求方式：PUT\n\n\u003e 说明：url 请求参数中最后需要指定 todo id\n\n请求参数：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv2gw0uml2j31bi0eymy1.jpg)\n\n响应结果：\n\n![](https://ws3.sinaimg.cn/large/006tNbRwly1fv2acucb8xj31e00f2gma.jpg)\n\n\n### 删除 Todo\n```\nhttps://waishuo.leanapp.cn/api/v1.0/todos/\u003ctodoId\u003e\n```\n\n请求方式：DEL \n\n请求参数：\n\n\u003e 说明：url 请求参数中最后需要指定 todo id\n\n响应结果：\n\n![](https://ws2.sinaimg.cn/large/006tNbRwly1fv2adkk67pj31ec05sweh.jpg)\n\n### 获取 Todo\n```\nhttps://waishuo.leanapp.cn/api/v1.0/todos/\u003ctodoId\u003e\n```\n\n请求方式：GET \n\n请求参数：\n\n\u003e 说明：url 请求参数中最后需要指定 todo id\n\n响应结果：\n\n![](https://ws2.sinaimg.cn/large/006tNbRwly1fv2aemqnszj31ea0hqwfp.jpg)\n\n\n-----\n\n## 分组 API\n\n### 创建分组\n```\nhttps://waishuo.leanapp.cn/api/v1.0/groups\n```\n\n请求方式：POST \n\n请求参数：\n\n![](https://ws4.sinaimg.cn/large/006tNbRwly1fv2atskz8rj31bc0aiwev.jpg)\n\n响应结果：\n\n![](https://ws2.sinaimg.cn/large/006tNbRwly1fv2au53o3dj31e00d6js3.jpg)\n\n\n### 更新分组\n```\nhttps://waishuo.leanapp.cn/api/v1.0/groups/\u003cgroupId\u003e\n```\n\n请求方式：PUT\n\n\u003e 说明：url 请求参数中最后需要指定 groupId\n\n请求参数：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv2awsuikvj31ba0akaaf.jpg)\n\n响应结果：\n\n![](https://ws3.sinaimg.cn/large/006tNbRwly1fv2ax5naqij31e80eeaax.jpg)\n\n### 获取项目分组列表\n```\nhttps://waishuo.leanapp.cn/api/v1.0/groups/projects/\u003cprojectId\u003e\n```\n\n请求方式：GET\n\n请求参数：\n\n\u003e 说明：url 请求参数中最后需要指定 projectId\n\n响应结果：\n\n![](https://ws3.sinaimg.cn/large/006tNbRwly1fv2b730zvqj31dm0g8t9n.jpg)\n\n\n### 删除分组\n```\nhttps://waishuo.leanapp.cn/api/v1.0/groups/\u003cgroupId\u003e\n```\n\n请求方式：DEL \n\n请求参数：\n\n\u003e 说明：url 请求参数中最后需要指定 groupId\n\n响应结果：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv2axmd09bj31e005m3yi.jpg)\n\n-----\n\n## Project 相关 api\n\n### 创建项目\n```\nhttps://waishuo.leanapp.cn/api/v1.0/project\n```\n\n请求方式：POST\n\n请求参数：\n\n![](https://ws2.sinaimg.cn/large/006tNbRwly1fv23m9qfscj31bm06s0sx.jpg)\n\n响应结果：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv23lkafkcj31dk0c60te.jpg)\n\n### 编辑项目\n```\nhttps://waishuo.leanapp.cn/api/v1.0/project\n```\n\n请求方式：PUT\n\n请求参数：\n\n![](https://ws3.sinaimg.cn/large/006tNbRwly1fv2bfvigu6j31bk07y3yp.jpg)\n\n响应结果：\n\n![](https://ws1.sinaimg.cn/large/006tNbRwly1fv2bgplan5j31e20eawfd.jpg)\n\n### 删除项目\n```\nhttps://waishuo.leanapp.cn/api/v1.0/projects/\u003cprojectId\u003e\n```\n\n\u003e 注意：删除时，会把项目下的分组以及 todo 全部删除\n\n请求方式：DEL \n\n\u003e 说明：url 请求参数中最后需要指定 projectId\n\n## 关于作者\n* Android 工程师，[咕咚翻译](https://sspai.com/post/33226)等多款 APP 应用作者。\n* 微博：[大侠咕咚](http://weibo.com/maoruibin)\n* 个人主页：[咕咚](https://gudong.name/)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaoruibin%2Fliuye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaoruibin%2Fliuye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaoruibin%2Fliuye/lists"}