Skip to content

Commit dc5fc1c

Browse files
Kauid323QianLin-Jiaxi
authored andcommitted
Add community API documentation for follow/unfollow
1 parent 2e902b4 commit dc5fc1c

1 file changed

Lines changed: 159 additions & 0 deletions

File tree

src/api/v1/community.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1286,3 +1286,162 @@ POST /v1/community/posts/cancel-draft
12861286
"msg": "success" // 返回消息
12871287
}
12881288
```
1289+
1290+
## 关注分区
1291+
1292+
POST /v1/community/ba/user-follow-ba
1293+
1294+
请求头:
1295+
1296+
|名称|必须|备注|
1297+
|-----|-----|-----|
1298+
|token|||
1299+
1300+
请求体:
1301+
1302+
```JSONC
1303+
{
1304+
"baId": 45, // 分区id
1305+
"followSource": 2
1306+
}
1307+
```
1308+
1309+
响应体:
1310+
1311+
```JSONC
1312+
{
1313+
"code": 1, // 请求状态码,1为正常
1314+
"msg": "success" // 返回消息
1315+
}
1316+
```
1317+
1318+
## 取关分区
1319+
1320+
POST /v1/community/ba/user-unfollow-ba
1321+
1322+
请求头:
1323+
1324+
|名称|必须|备注|
1325+
|-----|-----|-----|
1326+
|token|||
1327+
1328+
请求体:
1329+
1330+
```JSONC
1331+
{
1332+
"baId": 45, // 分区id
1333+
}
1334+
```
1335+
1336+
响应体:
1337+
1338+
```JSONC
1339+
{
1340+
"code": 1, // 请求状态码,1为正常
1341+
"msg": "success" // 返回消息
1342+
}
1343+
```
1344+
1345+
## 置顶/取消置顶文章
1346+
1347+
POST /v1/community/posts/edit-sticky
1348+
1349+
请求头:
1350+
1351+
|名称|必须|备注|
1352+
|-----|-----|-----|
1353+
|token||必须是分区管理者|
1354+
1355+
请求体:
1356+
1357+
```JSONC
1358+
{
1359+
"postId": 45008 // 文章id(如果已经置顶了,则会取消置顶)
1360+
}
1361+
```
1362+
1363+
响应体:
1364+
1365+
```JSONC
1366+
{
1367+
"code": 1, // 请求状态码,1为正常
1368+
"msg": "success" // 返回消息
1369+
}
1370+
```
1371+
1372+
## 获取分区关注者列表
1373+
1374+
POST /v1/community/ba/follower-list
1375+
1376+
请求头:
1377+
1378+
|名称|必须|备注|
1379+
|-----|-----|-----|
1380+
|token||必须是分区管理者|
1381+
1382+
请求体:
1383+
1384+
```JSONC
1385+
{
1386+
"id": 115, // 分区id
1387+
"size": 20, // 每页显示的数量
1388+
"page": 1, // 第1页
1389+
"memberName": "" // 搜索关注者的关键词
1390+
}
1391+
```
1392+
1393+
响应体:
1394+
1395+
```JSONC
1396+
{
1397+
"code": 1, // 请求状态码,1为正常
1398+
"data": {
1399+
"followers": [
1400+
{
1401+
"id": 11930, //关注id(应该是)
1402+
"baId": 115, // 分区id
1403+
"userId": "1234567", // 关注者用户id
1404+
"delTime": 0,
1405+
"followSource": 2,
1406+
"createTime": 1763132265, // 关注时间戳
1407+
"userLevel": 0, // 关注者等级(0-普通,2-分区管理员)
1408+
"nickname": "是个人", // 关注者名称
1409+
"avatarUrl": "https://chat-img.jwznb.com/6900488d625d48ac45ba34eff5b1246c.jpg", // 关注者头像url
1410+
"vipUserid": "1234567", // 关注者vip用户id
1411+
"vipEndTime": 1765728069 // vip结束时间戳
1412+
}
1413+
],
1414+
"total": 1 // 总关注者数量
1415+
},
1416+
"msg": "success" // 返回消息
1417+
}
1418+
```
1419+
1420+
## 设置分区管理员
1421+
1422+
POST /v1/community/ba/manage-setting
1423+
1424+
请求头:
1425+
1426+
|名称|必须|备注|
1427+
|-----|-----|-----|
1428+
|token||必须是分区创建者|
1429+
1430+
请求体:
1431+
1432+
```JSONC
1433+
{
1434+
"baId": 115, // 分区id
1435+
"userId": "1234567", // 用户id
1436+
"userLevel": 2 // 关注者(用户)等级(0-普通,2-分区管理员)
1437+
}
1438+
```
1439+
1440+
响应体:
1441+
1442+
```JSONC
1443+
{
1444+
"code": 1, // 请求状态码,1为正常
1445+
"msg": "success" // 返回消息
1446+
}
1447+
```

0 commit comments

Comments
 (0)