API Doc

SAST Link API 文档

v1.0.0

Base URLs:

• 测试环境: http://localhost:8080/api/v1

用户

POST 注册

POST /user/register

Body 请求参数

password: xxxxx

请求参数

名称	位置	类型	必选	说明
TOKEN	head	string	是	TOKEN
password	body	string	否	none

返回示例

200 Response

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

POST 登录

POST /user/login

非第三方登录。 登录逻辑：首先用户先输入他的用户名，我们会先判断用户名是否存在再进行输入密码环节，如果用户名存在，返回一个ticket表示帐号存在并且会带有一个时长(这一步由验证账号有效性这个接口实现)，也就是说用户需要在ticket有效期间输入密码。

请求参数

名称	位置	类型	必选	说明
password	query	string	否	密码
LOGIN_TICKET	header	string	否	这是一个token

返回示例

200 Response

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

GET 获取用户基本信息

GET /user/info

返回示例

200 Response

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

POST 登出

POST /user/logout

请求参数

名称	位置	类型	必选	说明
TOKEN	header	string	是	none

返回示例

200 Response

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

验证器

GET 验证帐号有效性

GET /verify/account

这里的验证帐号有效性指的是验证是指帐号否已经注册过

请求参数

名称	位置	类型	必选	说明
username	query	string	否	none
flag	query	string	否	这个用于判断是登录接口还是注册接口。0 代表注册，1代表登录

返回示例

200 Response

{
  "success": true,
  "errCode": null,
  "errMsg": null,
  "data": {
    "exists": true,
    "ticket": 0
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
success	boolean	true	none		none
errCode	null	true	none		none
errMsg	null	true	none		none
data	object	true	none		none
exists	boolean	true	none		是否有效
ticket	integer	true	none		TOKEN有效时长

GET 发送验证邮件

GET /sendEmail

请求参数

名称	位置	类型	必选	说明
TICKET	header	string	否	类似一个 TOKEN 的东西

返回示例

200 Response

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

数据模型

统一返回格式

{
  "Success": true,
  "ErrCode": 0,
  "ErrMsg": "string",
  "Data": {
    "Token": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
Success	boolean	true	none		none
ErrCode	integer	true	none		none
ErrMsg	string	true	none		none
Data	object	true	none		none
Token	string	true	none		none

User

{
  "id": 0,
  "nickName": "string",
  "password": "string",
  "QQ_id": "string",
  "Lark_id": "string",
  "Github_id": "string",
  "Wechat_id": "string",
  "E-mail": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	integer	true	none	id	none
nickName	string	true	none	昵称	none
password	string	true	none	密码	none
QQ_id	string	false	none		none
Lark_id	string	false	none	飞书id	none
Github_id	string	false	none		none
Wechat_id	string	false	none		none
E-mail	string	true	none	邮箱	none