Skip to content
Malcolm edited this page Jul 7, 2016 · 9 revisions

基础接口(Base)

URL 方法 描述
/login POST 登录接口(支持 qsso,这里需要单独封装,让携程能自适应)
/logout POST 退出登录接口(实际上就是对 cookie 的清理)

大库接口(Repository)

URL 方法 描述
/repositories GET 获取全部大库(显示首页)
/repositories/:repoId GET 获取单个大库
/repositories/:repoId PATCH 修改单个大库的管理者

用户接口(User)

URL 方法 描述
/user GET 获取已登录用户信息

图标接口(Icon)

URL 方法 描述
/icons GET 获取全部已入库 icon 列表(可用参数查询)
/user/icons POST 新增图标(上传图标并提交审核之后触发)
/user/icons/:iconId GET 获取单个图标信息
/user/icons/:iconId PATCH 修改单个图标信息(依据不同权限进行处理,登录用户只能修改tag,管理员可以修改name)
/user/icons/:iconId DELETE 删除审核失败的图标
/user/icons GET 获取用户已上传的全部图标

审核接口(Audit)

URL 方法 描述
/owner/icons GET 按库返回待审核图标
/owner/repository/:repoId/icons POST 审核图标并将其加入大库

项目接口(Project)

URL 方法 描述
/projects GET 获取全部公开项目
/projects/:projectId(/version/:version) GET 获取公开项目信息(不传 version 默认为 0.0.0)
/user/projects GET 获取用户参与的全部项目
/user/projects POST 新增图标至新项目
/user/projects/:projectId/update POST 更新项目 0.0.0 版本全部图标至最新版
/user/projects/:projectId(/version/:version) GET 获取单个项目信息(不传 version 默认为 0.0.0)
/user/projects/:projectId PATCH 更新单个项目信息(项目管理者、项目成员、项目描述、公开/私密)
/user/projects/:projectId/icons POST 为项目添加图标
/user/projects/:projectId/icons DELETE 删除项目图标

日志接口(Log)

URL 方法 描述
/log/repositories/:repoId GET 按大库查询日志
/log/projects/:projectId GET 按项目查询日志

通知接口(Notification)

URL 方法 描述
/user/notifications/ GET 获取用户的全部通知
/user/notifications/:nId GET 查看通知详情(会标记为已读)
/user/notifications/mark POST 批量设置通知为已读