用户资料 - GdeiAssistant/GdeiAssistant GitHub Wiki

用户资料

Web API

  • 获取头像URL信息
接口地址:/api/avatar
请求方法:GET

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":"https://gdeiassistant-userdata.oss-cn-shenzhen.aliyuncs.com/avatar/chencaiyin.jpg?Expires=1552762440&OSSAccessKeyId=LTAIElGHErd1JLyq&Signature=g8a6fdrw6ukBRFwji5TwOtVdUHA%3D"
}
  • 更新头像信息
接口地址:/api/avatar
请求方法:POST

请求参数说明:

参数 可选 说明
avatar 头像文件Blob类型数据

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 获取用户个人资料
接口地址:/api/profile
请求方法:GET

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":{"avatarURL":null,"username":"lisiyi","kickname":"李思懿","gender":0,"genderOrientation":null,"faculty":null,"major":null,"customGenderName":null,"region":"中国","state":"广东","city":"广州"}
}
  • 获取用户个人简介
接口地址:/api/introduction
请求方法:GET

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":"李思懿的个人简介"
}
  • 更新用户个人简介
接口地址:/api/introduction
请求方法:POST

请求参数说明:

参数 可选 说明
introduction 个人简介内容

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 加载地区列表
接口地址:/api/locationList
请求方法:GET

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":[{"code":"BTN","name":"\uD83C\uDDE7\uD83C\uDDF9不丹","stateMap":{}},....,{"code":"ME","name":"\uD83C\uDDF2\uD83C\uDDEA黑山","stateMap":{}}]
}
  • 更新用户性别
接口地址:/api/profile/gender
请求方法:POST

请求参数说明:

参数 可选 说明
gender 性别选项下标
customGenderName 自定义性别,当性别选项下标为3时,必须填写

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 更新用户性取向
接口地址:/api/profile/genderOrientation
请求方法:POST

请求参数说明:

参数 可选 说明
genderOrientation 性取向选项下标

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 更新用户院系
接口地址:/api/profile/faculty
请求方法:POST

请求参数说明:

参数 可选 说明
faculty 院系选项下标

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 更新用户所在地
接口地址:/api/profile/location
请求方法:POST

请求参数说明:

参数 可选 说明
region 国家/地区代码
state 省/州代码
city 市/直辖市代码

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 更新用户专业
接口地址:/api/profile/major
请求方法:POST

请求参数说明:

参数 可选 说明
major 专业名称

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}
  • 更新用户昵称
接口地址:/api/profile/kickname
请求方法:POST

请求参数说明:

参数 可选 说明
kickname 昵称

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null
}

Restful API

  • 获取用户个人资料
接口地址:/rest/profile
请求方法:POST

请求参数说明:

参数 可选 说明
token 登录凭证签名

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":{"avatarURL":null,"username":"lisiyi","kickname":"李思懿","gender":0,"genderOrientation":null,"faculty":null,"major":null,"customGenderName":null,"region":"中国","state":"广东","city":"广州"}
}
  • 获取头像URL信息
接口地址:/rest/avatar/{username}
接口说明:{username}为用户名
请求方法:GET

返回示例,正确的JSON返回结果如下:

{
"success":true,
"code":null,
"message":null,
"data":"https://gdeiassistant-userdata.oss-cn-shenzhen.aliyuncs.com/avatar/chencaiyin.jpg?Expires=1552762440&OSSAccessKeyId=LTAIElGHErd1JLyq&Signature=g8a6fdrw6ukBRFwji5TwOtVdUHA%3D"
}