接口文档

Rocket PT

简介:Rocket PT 接口文档

[TOC]

2FA 两步验证相关

生成2FA二维码

接口地址:/api/totp/code

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

生成2FA二维码

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

删除2FA

接口地址:/api/totp/remove

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

验证保存2FA

接口地址:/api/totp/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

这个接口接收用户输入的两步认证码，并验证它是否正确，正确则保存

请求示例:

{
  "key": "",
  "uri": "",
  "code": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
totpVo	TOTP	body	true	TotpVo	TotpVo
key	密钥		true	string
uri	二维码内容		false	string
code	6位动态验证码		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

登录相关

修改密码

接口地址:/api/change-password

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

根据旧密码改密码

请求示例:

{
  "oldPassword": "",
  "newPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
changePasswordParam	修改密码	body	true	ChangePasswordParam	ChangePasswordParam
oldPassword	旧密码		true	string
newPassword	新密码		true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

获取验证码

接口地址:/api/code.jpg

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

根据uuid获取验证码

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
uuid	前端随机生成的UUID	query	true	string

响应状态:

状态码	说明	schema
200	OK

响应参数:

暂无

响应示例:

忘记密码

接口地址:/api/forgot-password

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

忘记密码 1 发送验证码 2 发送邮件 3 根据邮件重置密码

请求示例:

{
  "email": "",
  "uuid": "",
  "code": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
forgotPasswordParam	忘记密码	body	true	ForgotPasswordParam	ForgotPasswordParam
email			true	string
uuid	验证码 UUID		true	string
code	验证码		true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

是否登录

接口地址:/api/isLogin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

退出登录

接口地址:/api/logout

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

重置密码

接口地址:/api/reset-password

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

根据邮件重置密码

请求示例:

{
  "checkCode": "",
  "newPassword": "",
  "uuid": "",
  "code": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
resetPasswordParam	重置密码	body	true	ResetPasswordParam	ResetPasswordParam
checkCode			true	string
newPassword	新密码		true	string
uuid	验证码 UUID		true	string
code	验证码		true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

用户信息

接口地址:/api/userinfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

系统菜单资源相关

获取单个资源详情

接口地址:/api/resources/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

删除资源

接口地址:/api/resources/{resourceId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
resourceId		path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

新增资源

接口地址:/api/resources/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "pid": 0,
  "name": "",
  "url": "",
  "permission": "",
  "type": "",
  "icon": "",
  "sort": 0,
  "status": 0,
  "createBy": 0,
  "createTime": "",
  "updateBy": 0,
  "updateTime": "",
  "remark": "",
  "parentName": "",
  "parent": {
    "id": 0,
    "pid": 0,
    "name": "",
    "url": "",
    "permission": "",
    "type": "",
    "icon": "",
    "sort": 0,
    "status": 0,
    "createBy": 0,
    "createTime": "",
    "updateBy": 0,
    "updateTime": "",
    "remark": "",
    "parentName": "",
    "parent": "",
    "children": []
  },
  "children": [
    {
      "id": 0,
      "pid": 0,
      "name": "",
      "url": "",
      "permission": "",
      "type": "",
      "icon": "",
      "sort": 0,
      "status": 0,
      "createBy": 0,
      "createTime": "",
      "updateBy": 0,
      "updateTime": "",
      "remark": "",
      "parentName": "",
      "parent": "",
      "children": []
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
resourceEntity	ResourceEntity	body	true	ResourceEntity	ResourceEntity
id			false	integer(int32)
pid	父ID		false	integer(int32)
name	菜单名称		false	string
url	路由地址		false	string
permission	权限字符串		false	string
type	类型 0：目录 1：菜单 2：按钮 3：外链,可用值:DIR,MENU,BUTTON,LINK		false	string
icon	菜单图标		false	string
sort	显示顺序		false	integer(int32)
status	菜单状态 1显示 0隐藏		false	integer(int32)
createBy	创建者ID		false	integer(int32)
createTime	创建时间		false	string(date-time)
updateBy	更新者ID		false	integer(int32)
updateTime	更新时间		false	string(date-time)
remark	备注		false	string
parentName			false	string
parent			false	ResourceEntity	ResourceEntity
children			false	array	ResourceEntity

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

获取资源列表

接口地址:/api/resources/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

获取权限列表

接口地址:/api/resources/permission

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取权限列表

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

获取资源树

接口地址:/api/resources/tree

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

修改资源

接口地址:/api/resources/update

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "pid": 0,
  "name": "",
  "url": "",
  "permission": "",
  "type": "",
  "icon": "",
  "sort": 0,
  "status": 0,
  "createBy": 0,
  "createTime": "",
  "updateBy": 0,
  "updateTime": "",
  "remark": "",
  "parentName": "",
  "parent": {
    "id": 0,
    "pid": 0,
    "name": "",
    "url": "",
    "permission": "",
    "type": "",
    "icon": "",
    "sort": 0,
    "status": 0,
    "createBy": 0,
    "createTime": "",
    "updateBy": 0,
    "updateTime": "",
    "remark": "",
    "parentName": "",
    "parent": "",
    "children": []
  },
  "children": [
    {
      "id": 0,
      "pid": 0,
      "name": "",
      "url": "",
      "permission": "",
      "type": "",
      "icon": "",
      "sort": 0,
      "status": 0,
      "createBy": 0,
      "createTime": "",
      "updateBy": 0,
      "updateTime": "",
      "remark": "",
      "parentName": "",
      "parent": "",
      "children": []
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
resourceEntity	ResourceEntity	body	true	ResourceEntity	ResourceEntity
id			false	integer(int32)
pid	父ID		false	integer(int32)
name	菜单名称		false	string
url	路由地址		false	string
permission	权限字符串		false	string
type	类型 0：目录 1：菜单 2：按钮 3：外链,可用值:DIR,MENU,BUTTON,LINK		false	string
icon	菜单图标		false	string
sort	显示顺序		false	integer(int32)
status	菜单状态 1显示 0隐藏		false	integer(int32)
createBy	创建者ID		false	integer(int32)
createTime	创建时间		false	string(date-time)
updateBy	更新者ID		false	integer(int32)
updateTime	更新时间		false	string(date-time)
remark	备注		false	string
parentName			false	string
parent			false	ResourceEntity	ResourceEntity
children			false	array	ResourceEntity

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

系统角色相关

findRoles

接口地址:/api/roles

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

findRoleUsers

接口地址:/api/roles/{roleId}/users

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "page": 0,
  "size": 0,
  "prop": "",
  "sort": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleId		path	true	integer(int32)
orderPageParam	OrderPageParam	body	true	OrderPageParam	OrderPageParam
page			true	integer(int32)
size			true	integer(int32)
prop	排序字段		false	string
sort	排序规则		false	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

createRole

接口地址:/api/roles/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "name": "",
  "remark": "",
  "createBy": 0,
  "createTime": "",
  "updateBy": 0,
  "updateTime": "",
  "resourceIds": [],
  "users": [
    {
      "id": 0,
      "username": "",
      "avatar": "",
      "createTime": "",
      "nickname": "",
      "gender": 0,
      "state": 0,
      "email": "",
      "remark": "",
      "lastLogin": "",
      "lastAccess": "",
      "lastOffer": "",
      "privacy": 0,
      "level": 0,
      "levelMax": 0,
      "uploaded": 0,
      "downloaded": 0,
      "seedtime": 0,
      "leechtime": 0,
      "warning": true,
      "warningBy": 0,
      "warningTimes": 0,
      "warningUntil": "",
      "download": 0,
      "upload": 0,
      "inviter": 0,
      "bonus": 0,
      "exp": 0
    }
  ],
  "resourceEntities": [
    {
      "id": 0,
      "pid": 0,
      "name": "",
      "url": "",
      "permission": "",
      "type": "",
      "icon": "",
      "sort": 0,
      "status": 0,
      "createBy": 0,
      "createTime": "",
      "updateBy": 0,
      "updateTime": "",
      "remark": "",
      "parentName": "",
      "parent": "",
      "children": []
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleEntity	RoleEntity	body	true	RoleEntity	RoleEntity
id			false	integer(int32)
name	角色名称		false	string
remark	备注		false	string
createBy	创建者ID		false	integer(int32)
createTime	创建时间		false	string(date-time)
updateBy	更新者ID		false	integer(int32)
updateTime	更新时间		false	string(date-time)
resourceIds	角色菜单ID		false	array	integer(int32)
users			false	array	UserEntity
id			false	integer
username	username		false	string
avatar	头像		false	string
createTime	注册时间		false	string
nickname	昵称		false	string
gender	性别 0男 1女 2其他		false	integer
state	状态 0正常 1 已锁定 2未激活		false	integer
email	email		false	string
remark	管理备注		false	string
lastLogin	上次登录时间		false	string
lastAccess	上次访问时间		false	string
lastOffer			false	string
privacy	隐私级别		false	integer
level			false	integer
levelMax			false	integer
uploaded	上传量		false	integer
downloaded	下载量		false	integer
seedtime	做种时间		false	integer
leechtime	下载时间		false	integer
warning	警告状态		false	boolean
warningBy	警告者		false	integer
warningTimes	总警告次数		false	integer
warningUntil	警告到期时间		false	string
download			false	integer
upload			false	integer
inviter	上家ID		false	integer
bonus	魔力积分		false	integer
exp	经验值		false	integer
resourceEntities			false	array	ResourceEntity
id			false	integer
pid	父ID		false	integer
name	菜单名称		false	string
url	路由地址		false	string
permission	权限字符串		false	string
type	类型 0：目录 1：菜单 2：按钮 3：外链,可用值:DIR,MENU,BUTTON,LINK		false	string
icon	菜单图标		false	string
sort	显示顺序		false	integer
status	菜单状态 1显示 0隐藏		false	integer
createBy	创建者ID		false	integer
createTime	创建时间		false	string
updateBy	更新者ID		false	integer
updateTime	更新时间		false	string
remark	备注		false	string
parentName			false	string
parent			false	ResourceEntity	ResourceEntity
children			false	array	ResourceEntity

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

deleteRole

接口地址:/api/roles/remove/{roleId}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleId		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

changeResources

接口地址:/api/roles/update

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "name": "",
  "remark": "",
  "createBy": 0,
  "createTime": "",
  "updateBy": 0,
  "updateTime": "",
  "resourceIds": [],
  "users": [
    {
      "id": 0,
      "username": "",
      "avatar": "",
      "createTime": "",
      "nickname": "",
      "gender": 0,
      "state": 0,
      "email": "",
      "remark": "",
      "lastLogin": "",
      "lastAccess": "",
      "lastOffer": "",
      "privacy": 0,
      "level": 0,
      "levelMax": 0,
      "uploaded": 0,
      "downloaded": 0,
      "seedtime": 0,
      "leechtime": 0,
      "warning": true,
      "warningBy": 0,
      "warningTimes": 0,
      "warningUntil": "",
      "download": 0,
      "upload": 0,
      "inviter": 0,
      "bonus": 0,
      "exp": 0
    }
  ],
  "resourceEntities": [
    {
      "id": 0,
      "pid": 0,
      "name": "",
      "url": "",
      "permission": "",
      "type": "",
      "icon": "",
      "sort": 0,
      "status": 0,
      "createBy": 0,
      "createTime": "",
      "updateBy": 0,
      "updateTime": "",
      "remark": "",
      "parentName": "",
      "parent": "",
      "children": []
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleEntity	RoleEntity	body	true	RoleEntity	RoleEntity
id			false	integer(int32)
name	角色名称		false	string
remark	备注		false	string
createBy	创建者ID		false	integer(int32)
createTime	创建时间		false	string(date-time)
updateBy	更新者ID		false	integer(int32)
updateTime	更新时间		false	string(date-time)
resourceIds	角色菜单ID		false	array	integer(int32)
users			false	array	UserEntity
id			false	integer
username	username		false	string
avatar	头像		false	string
createTime	注册时间		false	string
nickname	昵称		false	string
gender	性别 0男 1女 2其他		false	integer
state	状态 0正常 1 已锁定 2未激活		false	integer
email	email		false	string
remark	管理备注		false	string
lastLogin	上次登录时间		false	string
lastAccess	上次访问时间		false	string
lastOffer			false	string
privacy	隐私级别		false	integer
level			false	integer
levelMax			false	integer
uploaded	上传量		false	integer
downloaded	下载量		false	integer
seedtime	做种时间		false	integer
leechtime	下载时间		false	integer
warning	警告状态		false	boolean
warningBy	警告者		false	integer
warningTimes	总警告次数		false	integer
warningUntil	警告到期时间		false	string
download			false	integer
upload			false	integer
inviter	上家ID		false	integer
bonus	魔力积分		false	integer
exp	经验值		false	integer
resourceEntities			false	array	ResourceEntity
id			false	integer
pid	父ID		false	integer
name	菜单名称		false	string
url	路由地址		false	string
permission	权限字符串		false	string
type	类型 0：目录 1：菜单 2：按钮 3：外链,可用值:DIR,MENU,BUTTON,LINK		false	string
icon	菜单图标		false	string
sort	显示顺序		false	integer
status	菜单状态 1显示 0隐藏		false	integer
createBy	创建者ID		false	integer
createTime	创建时间		false	string
updateBy	更新者ID		false	integer
updateTime	更新时间		false	string
remark	备注		false	string
parentName			false	string
parent			false	ResourceEntity	ResourceEntity
children			false	array	ResourceEntity

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

addUser

接口地址:/api/roles/user/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "userId": 0,
  "roleId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userRoleEntity	UserRoleEntity	body	true	UserRoleEntity	UserRoleEntity
id			false	integer(int32)
userId			false	integer(int32)
roleId			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

removeUser

接口地址:/api/roles/user/remove

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "userId": 0,
  "roleId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userRoleEntity	UserRoleEntity	body	true	UserRoleEntity	UserRoleEntity
id			false	integer(int32)
userId			false	integer(int32)
roleId			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

changeUsers

接口地址:/api/roles/user/update

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "roleId": 0,
  "userIds": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleUserParam	调整角色用户	body	true	RoleUserParam	RoleUserParam
roleId	角色ID		true	integer(int32)
userIds	用户ID		true	array	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

邀请相关

发送邀请

接口地址:/api/invite/send

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "",
  "email": "",
  "content": "",
  "remark": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
inviteParam	邀请	body	true	InviteParam	InviteParam
username			false	string
email			false	string
content	邀请内容		false	string
remark	备注		false	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

用户相关

用户详情

接口地址:/api/users/{userId}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

新增用户

接口地址:/api/users/create

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "username": "",
  "avatar": "",
  "createTime": "",
  "nickname": "",
  "gender": 0,
  "state": 0,
  "email": "",
  "remark": "",
  "lastLogin": "",
  "lastAccess": "",
  "lastOffer": "",
  "privacy": 0,
  "level": 0,
  "levelMax": 0,
  "uploaded": 0,
  "downloaded": 0,
  "seedtime": 0,
  "leechtime": 0,
  "warning": true,
  "warningBy": 0,
  "warningTimes": 0,
  "warningUntil": "",
  "download": 0,
  "upload": 0,
  "inviter": 0,
  "bonus": 0,
  "exp": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userEntity	UserEntity	body	true	UserEntity	UserEntity
id			false	integer(int32)
username	username		false	string
avatar	头像		false	string
createTime	注册时间		false	string(date-time)
nickname	昵称		false	string
gender	性别 0男 1女 2其他		false	integer(int32)
state	状态 0正常 1 已锁定 2未激活		false	integer(int32)
email	email		false	string
remark	管理备注		false	string
lastLogin	上次登录时间		false	string(date-time)
lastAccess	上次访问时间		false	string(date-time)
lastOffer			false	string(date-time)
privacy	隐私级别		false	integer(int32)
level			false	integer(int32)
levelMax			false	integer(int32)
uploaded	上传量		false	integer(int64)
downloaded	下载量		false	integer(int64)
seedtime	做种时间		false	integer(int64)
leechtime	下载时间		false	integer(int64)
warning	警告状态		false	boolean
warningBy	警告者		false	integer(int64)
warningTimes	总警告次数		false	integer(int32)
warningUntil	警告到期时间		false	string(date-time)
download			false	integer(int32)
upload			false	integer(int32)
inviter	上家ID		false	integer(int32)
bonus	魔力积分		false	integer(int64)
exp	经验值		false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

用户列表

接口地址:/api/users/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

用户列表

请求示例:

{
  "page": 0,
  "size": 0,
  "id": 0,
  "avatar": "",
  "createdTime": "",
  "fullName": "",
  "gender": 0,
  "state": 0,
  "username": "",
  "organizationId": 0,
  "email": "",
  "added": "",
  "lastLogin": "",
  "lastAccess": "",
  "lastHome": "",
  "lastOffer": "",
  "forumAccess": "",
  "lastStaffmsg": "",
  "lastPm": "",
  "lastComment": "",
  "lastPost": "",
  "lastActive": "",
  "privacy": 0,
  "regIp": "",
  "level": 0,
  "uploaded": 0,
  "downloaded": 0,
  "seedtime": 0,
  "leechtime": 0,
  "modcomment": "",
  "warningBy": 0,
  "warningTimes": 0,
  "warning": true,
  "warningUntil": "",
  "download": 0,
  "upload": 0,
  "invitedBy": 0,
  "bonus": 0,
  "exp": 0,
  "checkCode": "",
  "regType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userParam	UserParam	body	true	UserParam	UserParam
page			true	integer(int32)
size			true	integer(int32)
id			false	integer(int32)
avatar			false	string
createdTime			false	string(date-time)
fullName			false	string
gender			false	integer(int32)
state			false	integer(int32)
username			false	string
organizationId			false	integer(int64)
email			false	string
added			false	string(date-time)
lastLogin			false	string(date-time)
lastAccess			false	string(date-time)
lastHome			false	string(date-time)
lastOffer			false	string(date-time)
forumAccess			false	string(date-time)
lastStaffmsg			false	string(date-time)
lastPm			false	string(date-time)
lastComment			false	string(date-time)
lastPost			false	string(date-time)
lastActive			false	string(date-time)
privacy			false	integer(int32)
regIp			false	string
level			false	integer(int32)
uploaded			false	integer(int64)
downloaded			false	integer(int64)
seedtime			false	integer(int64)
leechtime			false	integer(int64)
modcomment			false	string
warningBy			false	integer(int64)
warningTimes			false	integer(int32)
warning			false	boolean
warningUntil			false	string(date-time)
download			false	integer(int32)
upload			false	integer(int32)
invitedBy			false	integer(int32)
bonus			false	integer(int64)
exp			false	integer(int64)
checkCode			false	string
regType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

锁定用户

接口地址:/api/users/lock/{userId}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

删除用户

接口地址:/api/users/remove/{userId}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

解锁用户

接口地址:/api/users/unlock/{userId}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

编辑用户

接口地址:/api/users/update

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "username": "",
  "avatar": "",
  "createTime": "",
  "nickname": "",
  "gender": 0,
  "state": 0,
  "email": "",
  "remark": "",
  "lastLogin": "",
  "lastAccess": "",
  "lastOffer": "",
  "privacy": 0,
  "level": 0,
  "levelMax": 0,
  "uploaded": 0,
  "downloaded": 0,
  "seedtime": 0,
  "leechtime": 0,
  "warning": true,
  "warningBy": 0,
  "warningTimes": 0,
  "warningUntil": "",
  "download": 0,
  "upload": 0,
  "inviter": 0,
  "bonus": 0,
  "exp": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userEntity	UserEntity	body	true	UserEntity	UserEntity
id			false	integer(int32)
username	username		false	string
avatar	头像		false	string
createTime	注册时间		false	string(date-time)
nickname	昵称		false	string
gender	性别 0男 1女 2其他		false	integer(int32)
state	状态 0正常 1 已锁定 2未激活		false	integer(int32)
email	email		false	string
remark	管理备注		false	string
lastLogin	上次登录时间		false	string(date-time)
lastAccess	上次访问时间		false	string(date-time)
lastOffer			false	string(date-time)
privacy	隐私级别		false	integer(int32)
level			false	integer(int32)
levelMax			false	integer(int32)
uploaded	上传量		false	integer(int64)
downloaded	下载量		false	integer(int64)
seedtime	做种时间		false	integer(int64)
leechtime	下载时间		false	integer(int64)
warning	警告状态		false	boolean
warningBy	警告者		false	integer(int64)
warningTimes	总警告次数		false	integer(int32)
warningUntil	警告到期时间		false	string(date-time)
download			false	integer(int32)
upload			false	integer(int32)
inviter	上家ID		false	integer(int32)
bonus	魔力积分		false	integer(int64)
exp	经验值		false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

用户注册

注册

接口地址:/api/register

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "type": 0,
  "username": "",
  "nickname": "",
  "email": "",
  "password": "",
  "uuid": "",
  "code": "",
  "invitationCode": "",
  "country": "",
  "sex": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
registerParam	注册表单	body	true	RegisterParam	RegisterParam
type	注册类型		true	integer(int32)
username	用户名		true	string
nickname	昵称		true	string
email			true	string
password	password		true	string
uuid	验证码uuid		true	string
code	验证码		true	string
invitationCode	邀请码		false	string
country	国家地区		false	string
sex	性别 0 男 1 女 2 其他		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

注册确认

接口地址:/api/register/confirm/{code}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	邮件里面的code	path	true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

torrent种子相关

delete

接口地址:/api/torrent/delete

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

[]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
integers	integer	body	true	array

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

下载

接口地址:/api/torrent/download

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK

响应参数:

暂无

响应示例:

info_1

接口地址:/api/torrent/info/{id}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

list

接口地址:/api/torrent/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "total": 0,
  "size": 0,
  "current": 0,
  "orders": [
    {
      "column": "",
      "asc": true
    }
  ],
  "optimizeCountSql": true,
  "searchCount": true,
  "optimizeJoinOfCountSql": true,
  "maxLimit": 0,
  "countId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customPage	CustomPage	body	true	CustomPage	CustomPage
total			false	integer(int64)
size			false	integer(int64)
current			false	integer(int64)
orders			false	array	OrderItem
column			false	string
asc			false	boolean
optimizeCountSql			false	boolean
searchCount			false	boolean
optimizeJoinOfCountSql			false	boolean
maxLimit			false	integer(int64)
countId			false	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

save_1

接口地址:/api/torrent/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "infoHash": [],
  "name": "",
  "filename": "",
  "saveAs": "",
  "cover": "",
  "descr": "",
  "smallDescr": "",
  "oriDescr": "",
  "category": 0,
  "source": 0,
  "medium": 0,
  "codec": 0,
  "standard": 0,
  "processing": 0,
  "team": 0,
  "audiocodec": 0,
  "size": 0,
  "added": "",
  "type": "",
  "numfiles": 0,
  "comments": 0,
  "views": 0,
  "hits": 0,
  "timesCompleted": 0,
  "leechers": 0,
  "seeders": 0,
  "lastAction": "",
  "visible": "",
  "banned": "",
  "owner": 0,
  "spState": 0,
  "promotionTimeType": 0,
  "promotionUntil": "",
  "anonymous": "",
  "url": 0,
  "posState": "",
  "posStateUntil": "",
  "cacheStamp": 0,
  "picktype": "",
  "picktime": "",
  "lastReseed": "",
  "ptGen": "",
  "technicalInfo": "",
  "hr": 0,
  "approvalStatus": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
torrentsEntity	TorrentsEntity	body	true	TorrentsEntity	TorrentsEntity
id			false	integer(int32)
infoHash			false	array	string(byte)
name			false	string
filename			false	string
saveAs			false	string
cover			false	string
descr			false	string
smallDescr			false	string
oriDescr			false	string
category			false	integer(int32)
source			false	integer(int32)
medium			false	integer(int32)
codec			false	integer(int32)
standard			false	integer(int32)
processing			false	integer(int32)
team			false	integer(int32)
audiocodec			false	integer(int32)
size			false	integer(int64)
added			false	string(date-time)
type	可用值:single,multi		false	string
numfiles			false	integer(int32)
comments			false	integer(int32)
views			false	integer(int32)
hits			false	integer(int32)
timesCompleted			false	integer(int32)
leechers			false	integer(int32)
seeders			false	integer(int32)
lastAction			false	string(date-time)
visible			false	string
banned			false	string
owner			false	integer(int32)
spState			false	integer(int32)
promotionTimeType			false	integer(int32)
promotionUntil			false	string(date-time)
anonymous			false	string
url			false	integer(int32)
posState			false	string
posStateUntil			false	string(date-time)
cacheStamp			false	integer(int32)
picktype			false	string
picktime			false	string(date-time)
lastReseed			false	string(date-time)
ptGen			false	string
technicalInfo			false	string
hr			false	integer(int32)
approvalStatus			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

saveOrUpdate

接口地址:/api/torrent/saveOrUpdate

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "infoHash": [],
  "name": "",
  "filename": "",
  "saveAs": "",
  "cover": "",
  "descr": "",
  "smallDescr": "",
  "oriDescr": "",
  "category": 0,
  "source": 0,
  "medium": 0,
  "codec": 0,
  "standard": 0,
  "processing": 0,
  "team": 0,
  "audiocodec": 0,
  "size": 0,
  "added": "",
  "type": "",
  "numfiles": 0,
  "comments": 0,
  "views": 0,
  "hits": 0,
  "timesCompleted": 0,
  "leechers": 0,
  "seeders": 0,
  "lastAction": "",
  "visible": "",
  "banned": "",
  "owner": 0,
  "spState": 0,
  "promotionTimeType": 0,
  "promotionUntil": "",
  "anonymous": "",
  "url": 0,
  "posState": "",
  "posStateUntil": "",
  "cacheStamp": 0,
  "picktype": "",
  "picktime": "",
  "lastReseed": "",
  "ptGen": "",
  "technicalInfo": "",
  "hr": 0,
  "approvalStatus": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
torrentsEntity	TorrentsEntity	body	true	TorrentsEntity	TorrentsEntity
id			false	integer(int32)
infoHash			false	array	string(byte)
name			false	string
filename			false	string
saveAs			false	string
cover			false	string
descr			false	string
smallDescr			false	string
oriDescr			false	string
category			false	integer(int32)
source			false	integer(int32)
medium			false	integer(int32)
codec			false	integer(int32)
standard			false	integer(int32)
processing			false	integer(int32)
team			false	integer(int32)
audiocodec			false	integer(int32)
size			false	integer(int64)
added			false	string(date-time)
type	可用值:single,multi		false	string
numfiles			false	integer(int32)
comments			false	integer(int32)
views			false	integer(int32)
hits			false	integer(int32)
timesCompleted			false	integer(int32)
leechers			false	integer(int32)
seeders			false	integer(int32)
lastAction			false	string(date-time)
visible			false	string
banned			false	string
owner			false	integer(int32)
spState			false	integer(int32)
promotionTimeType			false	integer(int32)
promotionUntil			false	string(date-time)
anonymous			false	string
url			false	integer(int32)
posState			false	string
posStateUntil			false	string(date-time)
cacheStamp			false	integer(int32)
picktype			false	string
picktime			false	string(date-time)
lastReseed			false	string(date-time)
ptGen			false	string
technicalInfo			false	string
hr			false	integer(int32)
approvalStatus			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

update

接口地址:/api/torrent/update

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "infoHash": [],
  "name": "",
  "filename": "",
  "saveAs": "",
  "cover": "",
  "descr": "",
  "smallDescr": "",
  "oriDescr": "",
  "category": 0,
  "source": 0,
  "medium": 0,
  "codec": 0,
  "standard": 0,
  "processing": 0,
  "team": 0,
  "audiocodec": 0,
  "size": 0,
  "added": "",
  "type": "",
  "numfiles": 0,
  "comments": 0,
  "views": 0,
  "hits": 0,
  "timesCompleted": 0,
  "leechers": 0,
  "seeders": 0,
  "lastAction": "",
  "visible": "",
  "banned": "",
  "owner": 0,
  "spState": 0,
  "promotionTimeType": 0,
  "promotionUntil": "",
  "anonymous": "",
  "url": 0,
  "posState": "",
  "posStateUntil": "",
  "cacheStamp": 0,
  "picktype": "",
  "picktime": "",
  "lastReseed": "",
  "ptGen": "",
  "technicalInfo": "",
  "hr": 0,
  "approvalStatus": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
torrentsEntity	TorrentsEntity	body	true	TorrentsEntity	TorrentsEntity
id			false	integer(int32)
infoHash			false	array	string(byte)
name			false	string
filename			false	string
saveAs			false	string
cover			false	string
descr			false	string
smallDescr			false	string
oriDescr			false	string
category			false	integer(int32)
source			false	integer(int32)
medium			false	integer(int32)
codec			false	integer(int32)
standard			false	integer(int32)
processing			false	integer(int32)
team			false	integer(int32)
audiocodec			false	integer(int32)
size			false	integer(int64)
added			false	string(date-time)
type	可用值:single,multi		false	string
numfiles			false	integer(int32)
comments			false	integer(int32)
views			false	integer(int32)
hits			false	integer(int32)
timesCompleted			false	integer(int32)
leechers			false	integer(int32)
seeders			false	integer(int32)
lastAction			false	string(date-time)
visible			false	string
banned			false	string
owner			false	integer(int32)
spState			false	integer(int32)
promotionTimeType			false	integer(int32)
promotionUntil			false	string(date-time)
anonymous			false	string
url			false	integer(int32)
posState			false	string
posStateUntil			false	string(date-time)
cacheStamp			false	integer(int32)
picktype			false	string
picktime			false	string(date-time)
lastReseed			false	string(date-time)
ptGen			false	string
technicalInfo			false	string
hr			false	integer(int32)
approvalStatus			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

上传

接口地址:/api/torrent/upload

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 0,
  "infoHash": [],
  "name": "",
  "filename": "",
  "saveAs": "",
  "cover": "",
  "descr": "",
  "smallDescr": "",
  "oriDescr": "",
  "category": 0,
  "source": 0,
  "medium": 0,
  "codec": 0,
  "standard": 0,
  "processing": 0,
  "team": 0,
  "audiocodec": 0,
  "size": 0,
  "added": "",
  "type": "",
  "numfiles": 0,
  "comments": 0,
  "views": 0,
  "hits": 0,
  "timesCompleted": 0,
  "leechers": 0,
  "seeders": 0,
  "lastAction": "",
  "visible": "",
  "banned": "",
  "owner": 0,
  "spState": 0,
  "promotionTimeType": 0,
  "promotionUntil": "",
  "anonymous": "",
  "url": 0,
  "posState": "",
  "posStateUntil": "",
  "cacheStamp": 0,
  "picktype": "",
  "picktime": "",
  "lastReseed": "",
  "ptGen": "",
  "technicalInfo": "",
  "hr": 0,
  "approvalStatus": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file		query	true	file
torrentsEntity	TorrentsEntity	body	true	TorrentsEntity	TorrentsEntity
id			false	integer(int32)
infoHash			false	array	string(byte)
name			false	string
filename			false	string
saveAs			false	string
cover			false	string
descr			false	string
smallDescr			false	string
oriDescr			false	string
category			false	integer(int32)
source			false	integer(int32)
medium			false	integer(int32)
codec			false	integer(int32)
standard			false	integer(int32)
processing			false	integer(int32)
team			false	integer(int32)
audiocodec			false	integer(int32)
size			false	integer(int64)
added			false	string(date-time)
type	可用值:single,multi		false	string
numfiles			false	integer(int32)
comments			false	integer(int32)
views			false	integer(int32)
hits			false	integer(int32)
timesCompleted			false	integer(int32)
leechers			false	integer(int32)
seeders			false	integer(int32)
lastAction			false	string(date-time)
visible			false	string
banned			false	string
owner			false	integer(int32)
spState			false	integer(int32)
promotionTimeType			false	integer(int32)
promotionUntil			false	string(date-time)
anonymous			false	string
url			false	integer(int32)
posState			false	string
posStateUntil			false	string(date-time)
cacheStamp			false	integer(int32)
picktype			false	string
picktime			false	string(date-time)
lastReseed			false	string(date-time)
ptGen			false	string
technicalInfo			false	string
hr			false	integer(int32)
approvalStatus			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object
page	ResPage	ResPage
total	integer(int64)
page	integer(int32)
size	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {},
	"page": {
		"total": 0,
		"page": 0,
		"size": 0
	}
}

附录

接口基础

[TOC]

总则

所有接口尽量遵循REST规范。接口路径以 /api 或 /api/[version] 开头

请求

token信息后端会自动处理，放入cookie，前端无需关心

分页请求

{
  "page": 1,
  "size": 10,
  "keyword": "搜索关键字",
  "prop": "name",
  "sort": "name"
}

参数

参数名	必选	类型	说明
page	否	int	页码从1开始
size	否	int	每页size
keyword	否	string	模糊搜索关键字（如有）
prop	否	string	排序字段
sort	否	string	排序类型可选 "desc", "asc"

返回值

返回值结构如下

{
  "code": 0,
  "msg": "string",
  "data": {},
  "page": {
    "total": 1000,
    "page": 1,
    "size": 10
  }
}

返回参数详解

参数名	必选	类型	说明
code	是	int	状态码 0 为成功其他为失败
msg	是	string	提示信息
data	否	object 或 []	返回数据
page	否	object	分页信息（如有）
total		int	总记录数
page		int	当前页码
size		int	每页size

返回示例

  {
    "code": 0,
    "msg": "succeed",
    "data": {
      "uid": "1",
      "username": "12154545",
      "name": "吴系挂",
      "groupid": 2 ,
      "reg_time": "1436864169",
      "last_login_time": "0",
    }
  }

分页示例

{
  "code": 0,
  "msg": "succeed",
  "data": [
    {
      "uid": "1",
      "username": "12154545",
      "name": "吴系挂",
      "groupid": 2,
      "reg_time": "1436864169",
      "last_login_time": "0",
    }
  ],
  "page": {
    "total": 1000,
    "page": 25,
    "size": 10
  }
}

错误示例

{
  "code": 404,
  "msg": "User not found",
  "data": null
}

常见错误码

状态码	场景
0	成功
202	创建成功，通常用在异步操作时，表示请求已接受，但是还没有处理完成
400	参数错误，通常用在表单参数错误
401	授权错误，通常用在 Token 缺失或失效，注意 401 会触发前端跳转到登录页
403	操作被拒绝，通常发生在权限不足时，注意此时务必带上详细错误信息
404	没有找到对象，通常发生在使用错误的 id 查询详情
500	服务器错误

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loginParam	LoginParam	body	true	LoginParam	LoginParam
username	用户名		true	string
password			true	string
uuid	验证码 UUID		false	string
code	验证码		false	string
totp	两步验证码		false	integer(int32)

接口文档

Rocket PT

2FA 两步验证相关

生成2FA二维码

删除2FA

验证保存2FA

登录相关

修改密码

获取验证码

忘记密码

是否登录

登录

退出登录

重置密码

用户信息

系统菜单资源相关

获取单个资源详情

删除资源

新增资源

获取资源列表

获取权限列表

获取资源树

修改资源

系统角色相关

findRoles

findRoleUsers

createRole

deleteRole

changeResources

addUser

removeUser

changeUsers

邀请相关

发送邀请

用户相关

用户详情

新增用户

用户列表

锁定用户

删除用户

解锁用户

编辑用户

用户注册

注册

注册确认

torrent种子相关

delete

下载

info_1

list

save_1

saveOrUpdate

update

上传

附录

接口基础

接口基础

接口基础

总则

请求

分页请求

参数

返回值

返回参数详解

返回示例

分页示例

错误示例

常见错误码

Uh oh!

Clone this wiki locally