接口文档

服务器地址
http://ffffee.com:7315

状态码	描述
401	未授权
40001	用户名称已经存在
40002	密码格式错误

1. 登录

请求 URL：

/api/login

请求方式：

POST

参数：

参数名	必选	类型	说明
username	是	string	手机号/用户名/邮箱
password	是	string	密码

返回示例

json

{
  "code": 200,
  "message": "Login successful",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0OTVjNmM3OTU2NWVmNjYzOGMyMmEzNiIsInJvbGUiOiJtZW1iZXIiLCJpYXQiOjE2ODgwNDY4NDIsImV4cCI6MTY4ODY1MTY0Mn0.VWQgDRilPePMYz6w0MBT5f_5AoU4a2InvXTWcZiU_8o",
  "userId": "6495c6c79565ef6638c22a36"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
token	string	令牌
userId	string	用户 id

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

2. 注册

请求 URL：

/api/register

请求方式：

POST

参数：

参数名	必选	类型	说明
email	是	string	手机号/用户名/邮箱
password	是	string	密码，密码长度必须至少 6 个字符，最多 256 个字符，并包含数字、字母和特殊字符的组合。

返回示例

注册成功

json

{
  "code": 200,
  "message": "success"
}

用户已经存在

json

{
  "code": 40001,
  "message": "A user with the given username is already registered"
}

密码格式错误

json

{
  "code": 40002,
  "message": "无效的密码。密码长度必须至少6个字符，最多256个字符，并包含数字、字母和特殊字符的组合。"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
userId	string	用户 id

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

3. 退出登录

请求 URL：

/api/logout

请求方式：

POST

参数：

参数名	必选	类型	说明
userId	是	string	用户 id，登录接口获取

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

注册成功

json

{
  "code": 200,
  "message": "success"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

4. 用户列表

请求 URL：

/api/users/

请求方式：

参数：

参数名	必选	类型	说明
page	否	int	当前页,从 1 开始，默认 1
limit	否	int	每一页长度，默认 10
name	否	string	名称

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

成功

json

{
  "code": 200,
  "page": 1,
  "limit": 10,
  "data": [
    {
      "_id": "6495c6c79565ef6638c22a36",
      "email": "123@qq.com",
      "role": "member",
      "username": "123@qq.com",
      "__v": 0
    }
  ]
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
page	int	页码
limit	int	每一页长度
total	int	总条数
data	[]UserItem	列表数据

UserItem

参数名	类型	说明
_id	string	用户 id
email	string	邮箱
role	int	角色可选 member、admin，当 admin 的时候才可以获取用户列表
username	string	用户名称，默认值为 email

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

5. 删除用户（批量）

请求 URL：

/api/users/

请求方式：

DELETE

参数：

参数名	必选	类型	说明
userIds	是	[]UserId	用户 id 数组

UserId

参数名	必选	类型	说明
userId	是	string	用户 id

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

成功

json

{
  "code": 200,
  "message": "OK"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

6. 获取用户信息-通过 userId

请求 URL：

/api/users/{userId}

请求方式：

URL 参数：

参数名	必选	类型	说明
userId	是	string	用户 id，登录接口获取

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

成功

json

{
  "code": 200,
  "data": {
    "_id": "6495c6c79565ef6638c22a36",
    "email": "123@qq.com",
    "role": "member",
    "username": "123@qq.com",
    "__v": 0
  }
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

7. 更新用户信息-通过 userId

请求 URL：

/api/users/{userId}

请求方式：

URL 参数：

参数名	必选	类型	说明
userId	是	string	用户 id，登录接口获取

body 参数：

参数名	必选	类型	说明
_id	是	string	用户 id，登录接口获取
email	是	string	邮箱
role	是	string	角色，仅超级管理员可改，可选 member、admin
username	是	string	用户名称

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

成功

json

{
  "code": 200,
  "message": "success"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

8. 删除用户信息-通过 userId

请求 URL：

/api/users/{userId}

请求方式：

DELETE

URL 参数：

参数名	必选	类型	说明
userId	是	string	用户 id，登录接口获取

请求头参数

参数名	必选	类型	说明
Authorization	是	string	token，从登录接口获取

返回示例

成功

json

{
  "code": 200,
  "message": "success"
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息

备注

token 令牌，后续的接口参数中携带登录返回的 token 值
更多返回错误代码请看首页的错误代码描述

9. 文件上传

请求 URL：

http://xx.com/api/upload

请求方式：

POST

请求类型：

multipart/form-data

参数：

参数名	必选	类型	说明
sampleFile	是	file	文件块
currentChunk	是	int	当前文件块序号
totalChunks	是	int	文件总块数

返回示例

json

{
  "code": 200,
  "message": "success",
  "data": {
    "uploaded": true
  }
}

json

{
  "code": 400,
  "message": "No files were uploaded.",
  "data": {
    "uploaded": false
  }
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
data	Object	返回的数据

备注

更多返回错误代码请看首页的错误代码描述
文件分块上传，前端会将文件分割成多个块，每个块单独发送一个请求，服务器端需要支持处理多个请求并合并文件。

10. 文件块合并

请求 URL：

http://xx.com/api/merge

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
fileName	是	string	文件名
totalChunks	是	int	文件总块数

返回示例

json

{
  "code": 200,
  "message": "success",
  "data": {
    "merged": true
  }
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
data	Object	返回的数据

备注

更多返回错误代码请看首页的错误代码描述
当所有文件块上传完成后，前端会调用此接口进行文件块的合并。

根据你提供的代码，以下是对应的三个后端接口的文档 Markdown 模板：

11. 获取文件列表

请求 URL：

http://xx.com/api/filelist

请求方式：

返回示例

json

{
  "code": 200,
  "type": "success",
  "data": {
    "totalFiles": 100,
    "page": 1,
    "limit": 10,
    "files": ["file1", "file2", "file3"]
  }
}

返回参数说明：

参数名	类型	说明
code	int	状态码
type	string	响应类型，成功为 "success"
data	Object	返回的数据，包含一个文件名数组
data.totalFiles	Object	返回的数据，包含一个文件名数组
data.page	int	当前页
data.limit	int	每一条数
data.files	Array	文件名称列表

备注

更多返回错误代码请看首页的错误代码描述

12. 文件下载

请求 URL：

http://xx.com/api/download/{fileName}

请求方式：

URL 参数：

参数名	必选	类型	说明
fileName	是	string	文件名

返回：

文件的二进制流

备注

更多返回错误代码请看首页的错误代码描述

13. 删除文件

请求 URL：

http://xx.com/api/delete/{fileName}

请求方式：

DELETE

URL 参数：

参数名	必选	类型	说明
fileName	是	string	文件名

返回示例

json

{
  "code": 200,
  "message": "success",
  "data": {
    "deleted": true
  }
}

返回参数说明：

参数名	类型	说明
code	int	状态码
message	string	返回信息
data	Object	返回的数据

备注

更多返回错误代码请看首页的错误代码描述

快速实践指南

入门指南

基础知识

构建镜像

Node.js

Java

Dockerfile最佳实践

直播讲解 docker + nginx

咨询/接单/bug修复/学习交流群

接口文档 ​

1. 登录 ​

2. 注册 ​

3. 退出登录 ​

4. 用户列表 ​

5. 删除用户（批量） ​

6. 获取用户信息-通过 userId ​

7. 更新用户信息-通过 userId ​

8. 删除用户信息-通过 userId ​

9. 文件上传 ​

10. 文件块合并 ​

11. 获取文件列表 ​

12. 文件下载 ​

13. 删除文件 ​

接口文档

1. 登录

2. 注册

3. 退出登录

4. 用户列表

5. 删除用户（批量）

6. 获取用户信息-通过 userId

7. 更新用户信息-通过 userId

8. 删除用户信息-通过 userId

9. 文件上传

10. 文件块合并

11. 获取文件列表

12. 文件下载

13. 删除文件