EasyCloud是一个简易的文件分享平台。
- Java, Maven
- Spring, SpringMVC, Mybatis, MySQL
- Unit Test: JUnit4, Mockito, DbSetup, H2Database
- Travis自动构建 EasyCloud - Travis CI
- Codecov测试覆盖率预览 EasyCloud - Coverage
- 使用拦截器统一验证token
- 分享服务中,短链接使用长整形转62进制的方式实现
- 统一返回的数据格式
- 成功则返回200和需要的数据
{ "code":200, "data":{}, "msg":null }
- 失败则返回对应错误码和错误信息
{ "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
- 通用规范 api_common.md
- 文件模块 api_file.md
- 用户模块 api_user.md