基于REST的个人云存储系统API的分析与实现的中期报告.docx
文本预览下载声明
基于REST的个人云存储系统API的分析与实现的中期报告
一、开发进度
本次中期报告完成了个人云存储系统API的基本设计和部分的实现。实现的主要功能包括：
1.用户注册和登录功能，可以通过用户名和密码进行登录，注册时需要提供用户名、密码和邮箱。
2.文件上传和下载功能，用户可以将文件上传至云端存储，并可以下载自己存储的文件。
3.文件夹创建和删除功能，用户可以创建和删除自己的文件夹。
4.文件分享和收藏功能，用户可以分享自己的文件给其他用户，并可以收藏其他用户分享的文件。
5.支持基本的权限控制功能，可以设置文件或文件夹的可读写权限和是否公开。
二、API设计
本次API设计采用了常用的RESTful API设计规范，使用HTTP协议作为传输协议。以用户相关的API为例：
1.用户注册：
请求方式：POST
URL：/users
请求体：
{ “username”: “xxx”, “password”: “xxx”, “email”: “xxx” }
返回值：
{ “status”: “success”, “message”: “注册成功” }
2.用户登录：
请求方式：POST
URL：/login
请求体：
{ “username”: “xxx”, “password”: “xxx” }
返回值：
{ “status”: “success”, “message”: “登录成功”, “token”: “xxx” }
3.用户信息获取：
请求方式：GET
URL：/users/:id
请求头：
Authorization: Bearer xxx
返回值：
{ “username”: “xxx”, “email”: “xxx” }
三、技术栈和工具
本次API的实现采用了以下技术栈和工具：
1.后端框架：Express.js
2.数据库：MongoDB
3.密码加密：bcryptjs
4.身份验证：json web token (JWT)
5.文档编写：Swagger
6.测试工具：Postman
7.开发工具：Visual Studio Code
四、总结与展望
通过本次中期报告的实现，我们完成了个人云存储系统API的基本功能，同时遵循了RESTful API设计规范。下一步将继续完善权限控制、文件分享等功能的实现，同时进一步完善API文档和测试。
显示全部