Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 2.91 KB

README.md

File metadata and controls

64 lines (55 loc) · 2.91 KB

EasyCloud

Build Status codecov

简介

EasyCloud是一个简易的文件分享平台。

技术栈

设计

  • 使用拦截器统一验证token
  • 分享服务中,短链接使用长整形转62进制的方式实现
  • 统一返回的数据格式
    1. 成功则返回200和需要的数据
    {
      "code":200, 
      "data":{},
      "msg":null 
    }
    1. 失败则返回对应错误码和错误信息
    {
      "code":400, 
      "data":null,
      "msg":"参数错误" 
    }

接口概览 (已实现)

  • ~/api/pub/xxx 公共接口
  • ~/api/usr/xxx 用户登录才能访问,需要令牌
模块 描述 请求路径 方法 令牌 备注
用户 登录 /api/pub/login POST
注册 /api/pub/register POST
注销 /api/usr/logout GET 需要
文件 上传文件 /api/usr/file/upload POST 需要
获取用户的文件列表 /api/usr/file/list GET 需要
修改文件名 /api/usr/file/rename POST 需要
删除文件 /api/usr/file/delete POST 需要
分享文件 /api/usr/file/share POST 需要
取消分享 /api/usr/file/cancelShare POST 需要
获取个人分享列表 /api/usr/file/shareList GET 需要
下载 下载文件 /api/pub/download GET 非公开文件需要令牌
预览文件 /api/pub/preview GET 非公开文件需要令牌
分享 获取文件分享详情 /api/pub/share/{shortlink} GET

详细接口文档

文档路径: /doc/api_xxx.md