接口文档

Base URLs:

Authentication

授权控制器

POST 用户登录

POST /api/v1/auth/login

用户登录接口，用户登录后可以获取token；

Body 请求参数

{
  "user": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	LoginVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "user": {
      "uuid": "",
      "username": "",
      "email": "",
      "phone": "",
      "avatar": "",
      "enable": false,
      "ban": false,
      "createdAt": "",
      "updatedAt": "",
      "bannedAt": "",
      "userQq": "",
      "userWechat": ""
    },
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

登录结果

名称	类型	必选	约束	中文名	说明

POST 用户手机登录

POST /api/v1/auth/login/phone

用户手机登录接口，用户登录后可以获取token；

Body 请求参数

{
  "phone": "string",
  "code": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	LoginPhoneVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "user": {
      "uuid": "",
      "username": "",
      "email": "",
      "phone": "",
      "avatar": "",
      "enable": false,
      "ban": false,
      "createdAt": "",
      "updatedAt": "",
      "bannedAt": "",
      "userQq": "",
      "userWechat": ""
    },
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

登录结果

名称	类型	必选	约束	中文名	说明

POST 用户邮箱登录

POST /api/v1/auth/login/email

用户邮箱登录接口，用户登录后可以获取token；

Body 请求参数

{
  "email": "user@example.com",
  "code": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	LoginEmailVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "user": {
      "uuid": "",
      "username": "",
      "email": "",
      "phone": "",
      "avatar": "",
      "enable": false,
      "ban": false,
      "createdAt": "",
      "updatedAt": "",
      "bannedAt": "",
      "userQq": "",
      "userWechat": ""
    },
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

登录结果

名称	类型	必选	约束	中文名	说明

POST 用户注册

POST /api/v1/auth/register

用户注册接口，用户注册后可以获取token； 用户注册时需要提供用户名、密码、手机号码、邮箱等信息； 用户注册成功后，会返回token； 用户注册失败后，会返回失败信息；

Body 请求参数

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "userQq": "string",
  "userWechat": "string",
  "mailCode": "string",
  "phoneCode": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	RegisterVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

DELETE 用户登出

DELETE /api/v1/auth/logout

用户登出接口，用户登出后token失效； 用户登出后，需要重新登录；

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 用户重置密码

PUT /api/v1/auth/password/reset

用户忘记密码时，可以通过该接口重置密码；

Body 请求参数

{
  "username": "string",
  "email": "string",
  "phone": "string",
  "code": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	ResetPasswordVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 用户修改密码

PUT /api/v1/auth/password/change

用户可以通过该接口修改密码；

请求参数

名称	位置	类型	必选	说明
password	query	string	是	none
newPassword	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

登出结果

名称	类型	必选	约束	中文名	说明

DELETE 用户注销

DELETE /api/v1/auth/signout

用户可以通过该接口注销账号；

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

用户控制器

GET 获取当前用户信息

GET /api/v1/user/current

获取当前用户信息接口，用户登录后可以获取当前用户信息；

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "user": {
      "uuid": "",
      "username": "",
      "email": "",
      "phone": "",
      "avatar": "",
      "enable": false,
      "ban": false,
      "createdAt": "",
      "updatedAt": "",
      "bannedAt": "",
      "userQq": "",
      "userWechat": ""
    },
    "role": {
      "roleUuid": "",
      "name": "",
      "displayName": "",
      "description": ""
    },
    "member": {
      "name": "",
      "displayName": "",
      "description": ""
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

当前用户信息

名称	类型	必选	约束	中文名	说明

GET 获取用户详细信息

GET /api/v1/user/detail

获取用户详细信息接口，具有权限的用户可以获取用户详细信息；

请求参数

名称	位置	类型	必选	说明
user_uuid	query	string	否	用户UUID
user_name	query	string	否	用户名
user_email	query	string	否	用户邮箱
user_phone	query	string	否	用户电话
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "user": {
      "uuid": "",
      "username": "",
      "email": "",
      "phone": "",
      "avatar": "",
      "enable": false,
      "ban": false,
      "createdAt": "",
      "updatedAt": "",
      "bannedAt": "",
      "userQq": "",
      "userWechat": ""
    },
    "role": {
      "roleUuid": "",
      "name": "",
      "displayName": "",
      "description": ""
    },
    "member": {
      "name": "",
      "displayName": "",
      "description": ""
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

用户详细信息

名称	类型	必选	约束	中文名	说明

GET 获取用户列表

GET /api/v1/user/list

获取用户列表接口，具有权限的用户可以获取用户列表；

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	页码
size	query	integer	是	每页数量
type	query	string	是	none
order	query	boolean	是	none
search	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": [
    {
      "user": {
        "uuid": "",
        "username": "",
        "email": "",
        "phone": "",
        "avatar": "",
        "enable": false,
        "ban": false,
        "createdAt": "",
        "updatedAt": "",
        "bannedAt": "",
        "userQq": "",
        "userWechat": ""
      },
      "role": {
        "roleUuid": "",
        "name": "",
        "displayName": "",
        "description": ""
      },
      "member": {
        "name": "",
        "displayName": "",
        "description": ""
      }
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

用户列表

名称	类型	必选	约束	中文名	说明

PUT 编辑用户

PUT /api/v1/user/

编辑用户接口，具有权限的用户可以编辑用户信息；例如管理员用户可以修改用户为普通用户，或管理员用户（不可设置为 CONSOLE 用户）

Body 请求参数

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "avatar": "string",
  "enable": true,
  "role": "string",
  "member": "string",
  "info": {
    "qq": "string",
    "wechat": "string"
  }
}

请求参数

名称	位置	类型	必选	说明
uuid	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	EditUserVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 编辑用户邮箱

PUT /api/v1/user/email

编辑用户邮箱接口，具有权限的用户可以编辑用户邮箱；

请求参数

名称	位置	类型	必选	说明
email	query	string	是	none
code	query	string	是	none
password	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 编辑用户手机号

PUT /api/v1/user/phone

编辑用户手机号接口，具有权限的用户可以编辑用户手机号；

请求参数

名称	位置	类型	必选	说明
phone	query	string	是	none
code	query	string	是	none
password	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

公共控制器

GET 获取系统信息

GET /api/v2/public/systemInformation

获取系统信息

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "web": {
      "title": "",
      "subTitle": "",
      "keywords": "",
      "description": "",
      "icp": "",
      "logo": "",
      "favicon": ""
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

系统信息

名称	类型	必选	约束	中文名	说明

初始化控制器

POST 初始化

POST /api/v1/init/operate

Body 请求参数

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "aliyunKeyId": "string",
  "aliyunKeySecret": "string",
  "aliyunSmsSignName": "string",
  "aliyunSmsTemplateCode": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	InitVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

邮件控制器

GET 发送邮件

GET /api/v3/mail/send

1. 获取收件人 2. 获取模板 3. 获取 JSON 数据 4. 发送邮件 5. 返回结果 6. 记录日志

[{"key": "name","value": "张三"}]

请求参数

名称	位置	类型	必选	说明
to	query	string	是	收件人
temp	query	string	是	模板
subject	query	string	是	主题
data	query	string	否	JSON 数据
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

GET 发送验证码邮件

GET /api/v3/mail/send/code

1. 获取收件人 2. 发送邮件 3. 返回结果 4. 记录日志

请求参数

名称	位置	类型	必选	说明
to	query	string	是	收件人
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

短信控制器

GET 发送短信

GET /api/v3/sms/send

1. 获取收件人 2. 获取模板 3. 获取 JSON 数据 4. 发送短信 5. 返回结果 6. 记录日志

[{"key": "name","value": "张三"}]

请求参数

名称	位置	类型	必选	说明
to	query	string	是	收件人
temp	query	string	是	模板
data	query	string	否	JSON 数据
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

GET 发送验证码

GET /api/v3/sms/send/code

1. 获取收件人 2. 发送验证码 3. 返回结果 4. 记录日志

请求参数

名称	位置	类型	必选	说明
to	query	string	是	收件人
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

系统控制器

GET 系统停止

GET /api/v1/system/stop

系统停止接口，停止系统后会释放资源

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

卡片控制器

POST 添加卡片

POST /api/v1/card/

添加卡片接口，用于添加卡片

Body 请求参数

{
  "name": "string",
  "type": 1,
  "displayName": "string",
  "argumentAmount": 0,
  "argument": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	CardNormalVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

DELETE 删除卡片

DELETE /api/v1/card/

删除卡片接口，用于删除所有的卡片

请求参数

名称	位置	类型	必选	说明
card_uuid	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 更新卡片

PUT /api/v1/card/

更新卡片接口，用于更新卡片

Body 请求参数

{
  "name": "string",
  "type": 1,
  "displayName": "string",
  "argumentAmount": 0,
  "argument": "string"
}

请求参数

名称	位置	类型	必选	说明
card_uuid	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	CardNormalVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

实名认证控制器

POST 提交实名认证

POST /v1/api/real-authorization/user

提交实名认证,提交用户的实名认证信息,包括姓名、身份证号、身份证正反面等信息

Body 请求参数

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	RealAuthenticationVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 修改实名认证

PUT /v1/api/real-authorization/user

修改实名认证,修改用户的实名认证信息,包括姓名、身份证号、身份证正反面等信息

Body 请求参数

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	RealAuthenticationVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

POST 提交企业实名认证

POST /v1/api/real-authorization/company

提交企业实名认证,提交企业的实名认证信息,包括企业名称、营业执照号、营业执照等信息

Body 请求参数

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	RealAuthenticationVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

PUT 修改企业实名认证

PUT /v1/api/real-authorization/company

修改实名认证,修改用户的实名认证信息,包括姓名、身份证号、身份证正反面等信息

Body 请求参数

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Authorization	header	string	否	none
body	body	RealAuthenticationVO	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

结果

名称	类型	必选	约束	中文名	说明

GET 获取实名认证信息

GET /v1/api/real-authorization/

获取实名认证信息,获取用户的实名认证信息,包括姓名、身份证号、身份证正反面等信息

请求参数

名称	位置	类型	必选	说明
uuid	query	string	否	none
type	query	string	否	none
page	query	integer	否	none
limit	query	integer	否	none
search	query	string	否	none
order	query	string	否	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": [
    {
      "realInfo": {
        "type": false,
        "hasPass": 0,
        "name": "",
        "id": "",
        "idCardFrontLink": "",
        "idCardBackLink": "",
        "companyLicenseLink": "",
        "companyIdCardFrontFrontLink": "",
        "companyIdCardBackLink": "",
        "startTime": "",
        "endTime": "",
        "address": "",
        "createdAt": ""
      },
      "user": {
        "uuid": "",
        "username": "",
        "email": "",
        "phone": "",
        "avatar": "",
        "enable": false,
        "ban": false,
        "createdAt": "",
        "updatedAt": "",
        "bannedAt": "",
        "userQq": "",
        "userWechat": ""
      }
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

实名认证信息

名称	类型	必选	约束	中文名	说明

PUT 审核实名认证信息

PUT /v1/api/real-authorization/

审核实名认证信息,审核用户提交的实名认证信息,包括姓名、身份证号、身份证正反面等信息

请求参数

名称	位置	类型	必选	说明
userUuid	query	string	是	none
isPass	query	boolean	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

角色控制器

GET 获取角色信息

GET /api/v1/role/

获取角色信息接口，获取当前用户的角色信息；

请求参数

名称	位置	类型	必选	说明
roleUuid	query	string	是	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "roleUuid": "",
    "name": "",
    "displayName": "",
    "description": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

角色信息

名称	类型	必选	约束	中文名	说明

GET 获取角色列表

GET /api/v1/role/list

获取角色列表接口，获取所有角色列表；

请求参数

名称	位置	类型	必选	说明
page	query	integer	否	none
size	query	integer	否	none
Content-Type	header	string	是	none
Authorization	header	string	否	none

返回示例

成功

{
  "output": "",
  "code": 0,
  "message": "",
  "errorMessage": "",
  "data": {
    "records": [
      {
        "roleUuid": "",
        "name": "",
        "displayName": "",
        "description": ""
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

角色列表

名称	类型	必选	约束	中文名	说明

数据模型

ResponseEntity«BaseResponse«List«BackRealAuthorizationDTO»»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": [
    {
      "realInfo": {
        "type": true,
        "hasPass": 0,
        "name": "string",
        "id": "string",
        "idCardFrontLink": "string",
        "idCardBackLink": "string",
        "companyLicenseLink": "string",
        "companyIdCardFrontFrontLink": "string",
        "companyIdCardBackLink": "string",
        "startTime": "string",
        "endTime": "string",
        "address": "string",
        "createdAt": "string"
      },
      "user": {
        "uuid": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "avatar": "string",
        "enable": true,
        "ban": true,
        "createdAt": "string",
        "updatedAt": "string",
        "bannedAt": "string",
        "userQq": "string",
        "userWechat": "string"
      }
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	[BackRealAuthorizationDTO]¦null	false	none		none

BackRealAuthorizationDTO

{
  "realInfo": {
    "type": true,
    "hasPass": 0,
    "name": "string",
    "id": "string",
    "idCardFrontLink": "string",
    "idCardBackLink": "string",
    "companyLicenseLink": "string",
    "companyIdCardFrontFrontLink": "string",
    "companyIdCardBackLink": "string",
    "startTime": "string",
    "endTime": "string",
    "address": "string",
    "createdAt": "string"
  },
  "user": {
    "uuid": "string",
    "username": "string",
    "email": "string",
    "phone": "string",
    "avatar": "string",
    "enable": true,
    "ban": true,
    "createdAt": "string",
    "updatedAt": "string",
    "bannedAt": "string",
    "userQq": "string",
    "userWechat": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
realInfo	RealAuthenticationDTO	false	none		none
user	UserInfoDTO	false	none		none

EditUserVO

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "avatar": "string",
  "enable": true,
  "role": "string",
  "member": "string",
  "info": {
    "qq": "string",
    "wechat": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
username	string¦null	false	none		none
email	string(email)¦null	false	none		none
phone	string¦null	false	none		none
password	string¦null	false	none		none
avatar	string¦null	false	none		none
enable	boolean¦null	true	none		none
role	string¦null	false	none		none
member	string¦null	false	none		none
info	UserInfo	false	none		none

UserInfo

{
  "qq": "string",
  "wechat": "string"
}

属性

名称	类型	必选	约束	中文名	说明
qq	string¦null	false	none		none
wechat	string¦null	false	none		none

ResponseEntity«BaseResponse«List«GetRealAuthorizationDTO»»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": [
    {
      "realAuthenticationDTO": {
        "type": true,
        "hasPass": 0,
        "name": "string",
        "id": "string",
        "idCardFrontLink": "string",
        "idCardBackLink": "string",
        "companyLicenseLink": "string",
        "companyIdCardFrontFrontLink": "string",
        "companyIdCardBackLink": "string",
        "startTime": "string",
        "endTime": "string",
        "address": "string",
        "createdAt": "string"
      },
      "userInfoDTO": {
        "uuid": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "avatar": "string",
        "enable": true,
        "ban": true,
        "createdAt": "string",
        "updatedAt": "string",
        "bannedAt": "string",
        "userQq": "string",
        "userWechat": "string"
      }
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	[GetRealAuthorizationDTO]¦null	false	none		none

GetRealAuthorizationDTO

{
  "realAuthenticationDTO": {
    "type": true,
    "hasPass": 0,
    "name": "string",
    "id": "string",
    "idCardFrontLink": "string",
    "idCardBackLink": "string",
    "companyLicenseLink": "string",
    "companyIdCardFrontFrontLink": "string",
    "companyIdCardBackLink": "string",
    "startTime": "string",
    "endTime": "string",
    "address": "string",
    "createdAt": "string"
  },
  "userInfoDTO": {
    "uuid": "string",
    "username": "string",
    "email": "string",
    "phone": "string",
    "avatar": "string",
    "enable": true,
    "ban": true,
    "createdAt": "string",
    "updatedAt": "string",
    "bannedAt": "string",
    "userQq": "string",
    "userWechat": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
realAuthenticationDTO	RealAuthenticationDTO	false	none		none
userInfoDTO	UserInfoDTO	false	none		none

ResponseEntity«BaseResponse«ArrayList«RealAuthenticationDTO»»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": [
    {
      "type": true,
      "hasPass": 0,
      "name": "string",
      "id": "string",
      "idCardFrontLink": "string",
      "idCardBackLink": "string",
      "companyLicenseLink": "string",
      "companyIdCardFrontFrontLink": "string",
      "companyIdCardBackLink": "string",
      "startTime": "string",
      "endTime": "string",
      "address": "string",
      "createdAt": "string"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	[RealAuthenticationDTO]¦null	false	none		none

RealAuthenticationDTO

{
  "type": true,
  "hasPass": 0,
  "name": "string",
  "id": "string",
  "idCardFrontLink": "string",
  "idCardBackLink": "string",
  "companyLicenseLink": "string",
  "companyIdCardFrontFrontLink": "string",
  "companyIdCardBackLink": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string",
  "createdAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
type	boolean¦null	false	none		none
hasPass	number¦null	false	none		none
name	string¦null	false	none		none
id	string¦null	false	none		none
idCardFrontLink	string¦null	false	none		none
idCardBackLink	string¦null	false	none		none
companyLicenseLink	string¦null	false	none		none
companyIdCardFrontFrontLink	string¦null	false	none		none
companyIdCardBackLink	string¦null	false	none		none
startTime	string¦null	false	none		none
endTime	string¦null	false	none		none
address	string¦null	false	none		none
createdAt	string¦null	false	none		none

ResponseEntity«BaseResponse«List«UserDetailDTO»»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": [
    {
      "user": {
        "uuid": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "avatar": "string",
        "enable": true,
        "ban": true,
        "createdAt": "string",
        "updatedAt": "string",
        "bannedAt": "string",
        "userQq": "string",
        "userWechat": "string"
      },
      "role": {
        "roleUuid": "string",
        "name": "string",
        "displayName": "string",
        "description": "string"
      },
      "member": {
        "name": "string",
        "displayName": "string",
        "description": "string"
      }
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	[UserDetailDTO]¦null	false	none		none

ReviewRealNameAuthenticationVO

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

属性

名称	类型	必选	约束	中文名	说明
enterpriseCertification	boolean¦null	false	none		none
name	string¦null	false	none		none
id	string¦null	false	none		none
idCardFront	string¦null	false	none		none
idCardBack	string¦null	false	none		none
companyLicense	string¦null	false	none		none
companyIdCardFront	string¦null	false	none		none
companyIdCardBack	string¦null	false	none		none
startTime	string¦null	false	none		none
endTime	string¦null	false	none		none
address	string¦null	false	none		none

ResponseEntity«BaseResponse«RoleListDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "records": [
      {
        "roleUuid": "string",
        "name": "string",
        "displayName": "string",
        "description": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	RoleListDTO	false	none		none

RoleListDTO

{
  "records": [
    {
      "roleUuid": "string",
      "name": "string",
      "displayName": "string",
      "description": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "size": 0
}

属性

名称	类型	必选	约束	中文名	说明
records	[RoleDTO]¦null	false	none		none
total	integer¦null	false	none		none
page	integer¦null	false	none		none
size	integer¦null	false	none		none

ResponseEntity«RealAuthenticationDTO»

{
  "type": true,
  "haspPass": 0,
  "name": "string",
  "id": "string",
  "idCardFrontLink": "string",
  "idCardBackLink": "string",
  "companyLicenseLink": "string",
  "companyIdCardFrontFrontLink": "string",
  "companyIdCardBackLink": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string",
  "createdAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
type	boolean¦null	false	none		none
haspPass	number¦null	false	none		none
name	string¦null	false	none		none
id	string¦null	false	none		none
idCardFrontLink	string¦null	false	none		none
idCardBackLink	string¦null	false	none		none
companyLicenseLink	string¦null	false	none		none
companyIdCardFrontFrontLink	string¦null	false	none		none
companyIdCardBackLink	string¦null	false	none		none
startTime	string¦null	false	none		none
endTime	string¦null	false	none		none
address	string¦null	false	none		none
createdAt	string¦null	false	none		none

ResponseEntity«BaseResponse«RoleDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "roleUuid": "string",
    "name": "string",
    "displayName": "string",
    "description": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	RoleDTO	false	none		RoleDTO 角色DTO，包含角色信息

RealAuthenticationVO

{
  "enterpriseCertification": true,
  "name": "string",
  "id": "string",
  "idCardFront": "string",
  "idCardBack": "string",
  "companyLicense": "string",
  "companyIdCardFront": "string",
  "companyIdCardBack": "string",
  "startTime": "string",
  "endTime": "string",
  "address": "string"
}

属性

名称	类型	必选	约束	中文名	说明
enterpriseCertification	boolean¦null	false	none		none
name	string¦null	true	none		none
id	string¦null	false	none		none
idCardFront	string¦null	false	none		none
idCardBack	string¦null	false	none		none
companyLicense	string¦null	false	none		none
companyIdCardFront	string¦null	false	none		none
companyIdCardBack	string¦null	false	none		none
startTime	string¦null	true	none		none
endTime	string¦null	true	none		none
address	string¦null	true	none		none

ResponseEntity«BaseResponse«UserDetailDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "user": {
      "uuid": "string",
      "username": "string",
      "email": "string",
      "phone": "string",
      "avatar": "string",
      "enable": true,
      "ban": true,
      "createdAt": "string",
      "updatedAt": "string",
      "bannedAt": "string",
      "userQq": "string",
      "userWechat": "string"
    },
    "role": {
      "roleUuid": "string",
      "name": "string",
      "displayName": "string",
      "description": "string"
    },
    "member": {
      "name": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	UserDetailDTO	false	none		用户详细DTO 用户详细DTO，包含用户详细信息

UserDetailDTO

{
  "user": {
    "uuid": "string",
    "username": "string",
    "email": "string",
    "phone": "string",
    "avatar": "string",
    "enable": true,
    "ban": true,
    "createdAt": "string",
    "updatedAt": "string",
    "bannedAt": "string",
    "userQq": "string",
    "userWechat": "string"
  },
  "role": {
    "roleUuid": "string",
    "name": "string",
    "displayName": "string",
    "description": "string"
  },
  "member": {
    "name": "string",
    "displayName": "string",
    "description": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
user	UserInfoDTO	false	none		none
role	RoleDTO	false	none		RoleDTO 角色DTO，包含角色信息
member	MemberDTO	false	none		none

ResponseEntity«BaseResponse«UserTokenDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "token": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	UserTokenDTO	false	none		none

UserTokenDTO

{
  "token": "string"
}

属性

名称	类型	必选	约束	中文名	说明
token	string¦null	false	none		none

ResetPasswordVO

{
  "username": "string",
  "email": "string",
  "phone": "string",
  "code": "string",
  "password": "string"
}

属性

名称	类型	必选	约束	中文名	说明
username	string¦null	true	none		none
email	string¦null	false	none		none
phone	string¦null	false	none		none
code	string¦null	false	none		none
password	string¦null	true	none		none

ResponseEntity«BaseResponse«CardNormalVO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "name": "string",
    "type": 1,
    "displayName": "string",
    "argumentAmount": 0,
    "argument": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	CardNormalVO	false	none		none

CardNormalVO

{
  "name": "string",
  "type": 1,
  "displayName": "string",
  "argumentAmount": 0,
  "argument": "string"
}

属性

名称	类型	必选	约束	中文名	说明
name	string¦null	true	none		none
type	number¦null	false	none		none
displayName	string¦null	true	none		none
argumentAmount	integer¦null	false	none		none
argument	string¦null	true	none		none

LoginPhoneVO

{
  "phone": "string",
  "code": "string"
}

属性

名称	类型	必选	约束	中文名	说明
phone	string¦null	true	none		none
code	string¦null	true	none		none

LoginEmailVO

{
  "email": "user@example.com",
  "code": "string"
}

属性

名称	类型	必选	约束	中文名	说明
email	string(email)¦null	true	none		none
code	string¦null	true	none		none

ResponseEntity«BaseResponse«SystemInformationDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "web": {
      "title": "string",
      "subTitle": "string",
      "keywords": "string",
      "description": "string",
      "icp": "string",
      "logo": "string",
      "favicon": "string"
    }
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	SystemInformationDTO	false	none		none

ResponseEntity«BaseResponse«UserLoginDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "user": {
      "uuid": "string",
      "username": "string",
      "email": "string",
      "phone": "string",
      "avatar": "string",
      "enable": true,
      "ban": true,
      "createdAt": "string",
      "updatedAt": "string",
      "bannedAt": "string",
      "userQq": "string",
      "userWechat": "string"
    },
    "token": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	UserLoginDTO	false	none		none

UserCurrentDTO

{
  "user": {
    "uuid": "string",
    "username": "string",
    "email": "string",
    "phone": "string",
    "avatar": "string",
    "enable": true,
    "ban": true,
    "createdAt": "string",
    "updatedAt": "string",
    "bannedAt": "string",
    "userQq": "string",
    "userWechat": "string"
  },
  "role": {
    "roleUuid": "string",
    "name": "string",
    "displayName": "string",
    "description": "string"
  },
  "member": {
    "name": "string",
    "displayName": "string",
    "description": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
user	UserInfoDTO	false	none		none
role	RoleDTO	false	none		RoleDTO 角色DTO，包含角色信息
member	MemberDTO	false	none		none

SystemInformationDTO

{
  "web": {
    "title": "string",
    "subTitle": "string",
    "keywords": "string",
    "description": "string",
    "icp": "string",
    "logo": "string",
    "favicon": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
web	Web	false	none		none

UserLoginDTO

{
  "user": {
    "uuid": "string",
    "username": "string",
    "email": "string",
    "phone": "string",
    "avatar": "string",
    "enable": true,
    "ban": true,
    "createdAt": "string",
    "updatedAt": "string",
    "bannedAt": "string",
    "userQq": "string",
    "userWechat": "string"
  },
  "token": "string"
}

属性

名称	类型	必选	约束	中文名	说明
user	UserInfoDTO	false	none		none
token	string¦null	false	none		none

RegisterVO

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "userQq": "string",
  "userWechat": "string",
  "mailCode": "string",
  "phoneCode": "string"
}

属性

名称	类型	必选	约束	中文名	说明
username	string¦null	true	none		none
email	string(email)¦null	true	none		none
phone	string¦null	true	none		none
password	string¦null	true	none		none
userQq	string¦null	true	none		none
userWechat	string¦null	true	none		none
mailCode	string¦null	true	none		none
phoneCode	string¦null	true	none		none

InitVO

{
  "username": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "aliyunKeyId": "string",
  "aliyunKeySecret": "string",
  "aliyunSmsSignName": "string",
  "aliyunSmsTemplateCode": "string"
}

属性

名称	类型	必选	约束	中文名	说明
username	string¦null	true	none		none
email	string(email)¦null	true	none		none
phone	string¦null	true	none		none
password	string¦null	true	none		none
aliyunKeyId	string¦null	true	none		none
aliyunKeySecret	string¦null	true	none		none
aliyunSmsSignName	string¦null	true	none		none
aliyunSmsTemplateCode	string¦null	true	none		none

MemberDTO

{
  "name": "string",
  "displayName": "string",
  "description": "string"
}

属性

名称	类型	必选	约束	中文名	说明
name	string¦null	false	none		none
displayName	string¦null	false	none		none
description	string¦null	false	none		none

ResponseEntity«BaseResponse«UserCurrentDTO»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": {
    "user": {
      "uuid": "string",
      "username": "string",
      "email": "string",
      "phone": "string",
      "avatar": "string",
      "enable": true,
      "ban": true,
      "createdAt": "string",
      "updatedAt": "string",
      "bannedAt": "string",
      "userQq": "string",
      "userWechat": "string"
    },
    "role": {
      "roleUuid": "string",
      "name": "string",
      "displayName": "string",
      "description": "string"
    },
    "member": {
      "name": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	UserCurrentDTO	false	none		none

Web

{
  "title": "string",
  "subTitle": "string",
  "keywords": "string",
  "description": "string",
  "icp": "string",
  "logo": "string",
  "favicon": "string"
}

属性

名称	类型	必选	约束	中文名	说明
title	string¦null	false	none		none
subTitle	string¦null	false	none		none
keywords	string¦null	false	none		none
description	string¦null	false	none		none
icp	string¦null	false	none		none
logo	string¦null	false	none		none
favicon	string¦null	false	none		none

LoginVO

{
  "user": "string",
  "password": "string"
}

属性

名称	类型	必选	约束	中文名	说明
user	string¦null	true	none		none
password	string¦null	true	none		none

RoleDTO

{
  "roleUuid": "string",
  "name": "string",
  "displayName": "string",
  "description": "string"
}

属性

名称	类型	必选	约束	中文名	说明
roleUuid	string¦null	false	none		none
name	string¦null	false	none		none
displayName	string¦null	false	none		none
description	string¦null	false	none		none

ResponseEntity

{}

属性

None

UserInfoDTO

{
  "uuid": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "avatar": "string",
  "enable": true,
  "ban": true,
  "createdAt": "string",
  "updatedAt": "string",
  "bannedAt": "string",
  "userQq": "string",
  "userWechat": "string"
}

属性

名称	类型	必选	约束	中文名	说明
uuid	string¦null	false	none		none
username	string¦null	false	none		none
email	string¦null	false	none		none
phone	string¦null	false	none		none
avatar	string¦null	false	none		none
enable	boolean¦null	false	none		none
ban	boolean¦null	false	none		none
createdAt	string¦null	false	none		none
updatedAt	string¦null	false	none		none
bannedAt	string¦null	false	none		none
userQq	string¦null	false	none		none
userWechat	string¦null	false	none		none

ResponseEntity«BaseResponse«Void»»

{
  "output": "string",
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "data": null
}

属性

名称	类型	必选	约束	中文名	说明
output	string¦null	false	none		none
code	integer¦null	false	none		none
message	string¦null	false	none		none
errorMessage	string¦null	false	none		none
data	null¦null	false	none		none