OpenAPI 規範 (中文版) (apifox.cn)
OpenAPI definition-CSDN部落格
簡介:OpenAPI definition
HOST:http://192.168.41.191:8902/api/v1/user
聯絡人:
Version:v0
介面路徑:/user/v3/api-docs
[TOC]
學校管理
獲取學校列表
介面地址:/user/schools
請求方式:GET
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
獲取系統所有支援列表，供個人中心下拉框使用
請求引數:
暫無
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseListSchoolVO
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 array SchoolVO
id 學校id integer(int64)
schoolName 學校名稱 string
schoolAbbr 學校縮寫 string
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": [
{
"id": 1789548655582642177,
"schoolName": "哈爾濱理工大學",
"schoolAbbr": "HRBUST"
}
],
"msg": "success"
}
使用者管理
獲取使用者登入資訊
介面地址:/user/
請求方式:GET
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
常常用於第一次登陸成功或路由守衛檢查使用者登入態
請求引數:
暫無
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseUserDto
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data UserDto UserDto
userId 使用者id integer(int64)
username 使用者名稱 string
nickname 使用者暱稱 string
gender 使用者性別 string
age 使用者年齡 integer(int32)
userAvatar 使用者頭像url string
email 使用者郵箱 string
schoolName 使用者所屬學校名稱 string
schoolAbbr 使用者所屬學校簡寫 string
totalLikes 使用者在社群模組的獲贊總數 integer(int32)
totalComments 使用者在社群模組的被評論總數 integer(int32)
unReadCommentsCount 使用者未讀評論的總數 integer(int32)
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {
"userId": 1789548655582642177,
"username": "nick123",
"nickname": "尼克",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "han892577@qq.com",
"schoolName": "哈爾濱理工大學",
"schoolAbbr": "HRBUST",
"totalLikes": 100,
"totalComments": 200,
"unReadCommentsCount": 10
},
"msg": "success"
}
修改使用者資訊
介面地址:/user/
請求方式:PUT
請求資料型別:application/x-www-form-urlencoded,application/json
響應資料型別:*/*
介面描述:
請求示例:
{
"nickname": "尼克",
"password": "123456",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "han892577@qq.com",
"schoolAbbr": "HRBUST"
}
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
updateUserDto 更新使用者資訊dto body true UpdateUserDto UpdateUserDto
nickname 使用者暱稱 false string
password 使用者密碼(不傳為空) false string
gender 使用者性別 false string
age 使用者年齡 false integer(int32)
userAvatar 使用者頭像的url false string
email 使用者郵箱 false string
schoolAbbr 使用者學校(英文簡寫而非學校名稱) false string
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseObject
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 object
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {},
"msg": "success"
}
使用者登出
介面地址:/user/
請求方式:DELETE
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
請求引數:
暫無
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseObject
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 object
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {},
"msg": "success"
}
檢查使用者id是否合法
介面地址:/user/id
請求方式:GET
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
供後端系統遠端呼叫，前端不需關注
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
id query true integer(int64)
響應狀態:
狀態碼 說明 schema
200 OK
響應引數:
暫無
響應示例:
使用者登入
介面地址:/user/login
請求方式:POST
請求資料型別:application/x-www-form-urlencoded,application/json
響應資料型別:*/*
介面描述:
請求示例:
{
"username": "",
"password": ""
}
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
loginDto 使用者登入DTO body true LoginDto LoginDto
username 使用者名稱 true string
password 使用者密碼 true string
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseString
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 string
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": "",
"msg": "success"
}
獲取使用者所有未讀資訊
介面地址:/user/messages
請求方式:GET
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
請求引數:
暫無
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseListMessageDto
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 array MessageDto
id 訊息id integer(int64)
userId 當前評論使用者id（回覆你的評論） integer(int64)
userNickname 回覆評論的使用者暱稱 string
objName 當前評論所屬點評物件 string
objId 當前評論所屬點評物件id integer(int64)
replyUserId 被回覆的使用者id integer(int64)
replyCommentId 被回覆的評論id integer(int64)
content 回覆的評論內容 string
likes 評論所獲點贊數 integer(int32)
pubTime 評論釋出時間 string(date-time)
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": [
{
"id": 1789548655582642177,
"userId": 1789548655582642177,
"userNickname": "張三",
"objName": "服務端架構設計",
"objId": 1789548655582642177,
"replyUserId": 1789548655582642177,
"replyCommentId": 1789548655582642177,
"content": "你說的對，但是......",
"likes": 100,
"pubTime": ""
}
],
"msg": "success"
}
將訊息標記為已讀
介面地址:/user/read/messages
請求方式:PUT
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
點選去檢視以後傳送的請求
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
messageId 要標記的訊息id query true integer(int64)
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseObject
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 object
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {},
"msg": "success"
}
使用者註冊
介面地址:/user/register
請求方式:POST
請求資料型別:application/x-www-form-urlencoded,application/json
響應資料型別:*/*
介面描述:
請求示例:
{
"username": "",
"password": ""
}
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
loginDto 使用者登入DTO body true LoginDto LoginDto
username 使用者名稱 true string
password 使用者密碼 true string
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseObject
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 object
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {},
"msg": "success"
}
獲取使用者資訊
介面地址:/user/rpc
請求方式:GET
請求資料型別:application/x-www-form-urlencoded
響應資料型別:*/*
介面描述:
供後端系統遠端呼叫，前端不需關注
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
id header true integer(int64)
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseUserDto
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data UserDto UserDto
userId 使用者id integer(int64)
username 使用者名稱 string
nickname 使用者暱稱 string
gender 使用者性別 string
age 使用者年齡 integer(int32)
userAvatar 使用者頭像url string
email 使用者郵箱 string
schoolName 使用者所屬學校名稱 string
schoolAbbr 使用者所屬學校簡寫 string
totalLikes 使用者在社群模組的獲贊總數 integer(int32)
totalComments 使用者在社群模組的被評論總數 integer(int32)
unReadCommentsCount 使用者未讀評論的總數 integer(int32)
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": {
"userId": 1789548655582642177,
"username": "nick123",
"nickname": "尼克",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "han892577@qq.com",
"schoolName": "哈爾濱理工大學",
"schoolAbbr": "HRBUST",
"totalLikes": 100,
"totalComments": 200,
"unReadCommentsCount": 10
},
"msg": "success"
}
檔案上傳
介面地址:/user/upload
請求方式:POST
請求資料型別:application/x-www-form-urlencoded,application/json
響應資料型別:*/*
介面描述:
請求引數:
引數名稱 引數說明 請求型別 是否必須 資料型別 schema
file 檔案物件 query false file
響應狀態:
狀態碼 說明 schema
200 OK BaseResponseString
響應引數:
引數名稱 引數說明 型別 schema
code 響應碼，成功為0其他（4xxxx客戶端錯誤，5xxxx服務端錯誤） integer(int32) integer(int32)
data 響應資料 string
msg 響應訊息，成功為success，錯誤返回失敗資訊 string
響應示例:
{
"code": 0,
"data": "",
"msg": "success"