feat: 规范化文档

This commit is contained in:
wuziqian211 2024-07-06 23:33:37 +08:00
parent fdb428cc60
commit 478feea1b2
3 changed files with 177 additions and 137 deletions

View File

@ -10,95 +10,53 @@
**正文参数multipart/form-data**
| 参数名 | 类型 | 内容 |
| ---------- | ---- | ------ |
| dynamic_id | num | 动态id |
| csrf_token | str | csrf |
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ---------- | ---- | ------ | ------ | ---- |
| dynamic_id | num | 动态id | 必要 | |
| csrf_token | str | csrf | 必要 | |
| csrf | str | csrf | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 |
| ------- | ---- | ----------------- |
| code | num | 0:成功 |
| | | 500404:已经删除过 |
| | | 500406:不是自己的 |
| msg | str | 错误信息 |
| message | str | 和msg一样 |
| data | obj | 未知 |
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------------------------------------------------------------------- |
| code | num | 返回值 | 0成功<br />-101账号未登录<br />500404已经删除过该动态<br />500406动态不是自己的 |
| msg | str | 错误信息 | 成功时为空文本 |
| message | str | 错误信息 | 同`msg` |
| data | obj | 数据本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | ---- | ---------------- |
| \_gt\_ | num | 0 | **作用尚不明确** |
**示例:**
删除动态`dynamic_id=588320531406678918`
```shell
curl 'https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/rm_dynamic' \
--data-urlencode 'dynamic_id=588320531406678918' \
--data-urlencode 'csrf_token=xxx' \
--data-urlencode 'csrf=xxx' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看示例</summary>
```bash
curl 'https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/rm_dynamic' \
-X POST \
-H 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:93.0) Gecko/20100101 Firefox/93.0' \
-H 'Referer: https://t.bilibili.com/' \
-H 'Cookie: SESSDATA=********; bili_jct=de2731532b4ab96bc8536da948932668;' \
--data-raw 'dynamic_id=588320531406678918&csrf_token=de2731532b4ab96bc8536da948932668&csrf=de2731532b4ab96bc8536da948932668'
```
<summary>查看响应示例:</summary>
```json
{
"code":0,
"msg":"",
"message":"",
"code": 0,
"msg": "",
"message": "",
"data": {
"_gt_":0
"_gt_": 0
}
}
```
</details>
## 删除草稿
> https://api.vc.bilibili.com/dynamic_draft/v1/dynamic_draft/rm_draft
*请求方式POST*
认证方式CookieSESSDATA
**正文参数application/x-www-form-urlencoded**
| 参数名 | 类型 | 内容 |
| ---------- | ---- | -------------- |
| draft_id | num | 定时发送草稿id |
| csrf_token | str | csrf |
**json回复**
根对象:
| 字段 | 类型 | 内容 |
| ------- | ---- | ---------------------------- |
| code | num | 0:成功<br/>4120015: 系统异常 |
| message | str | 错误信息 |
| ttl | num | 1 |
| data | obj | 空对象 |
<details>
<summary>查看示例</summary>
```bash
curl -X POST 'https://api.vc.bilibili.com/dynamic_draft/v1/dynamic_draft/rm_draft' \
--data-urlencode 'draft_id=755409289278914611' \
--data-urlencode 'csrf=xxxx'
-b 'SESSDATA=xxxx;' \
```
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {}
}
```
</details>

View File

@ -1,6 +1,6 @@
# 根据关键字搜索用户(at别人时的填充列表)
# 根据关键字搜索用户 (at别人时的填充列表)
**注意关键字不一定顺序匹配,如最后示例**
**注意关键字不一定顺序匹配如最后示例**
> https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search
@ -8,60 +8,79 @@
认证方式CookieSESSDATA
**正文参数multipart/form-data**
**url参数**
| 参数名 | 类型 | 内容 |
| --- | --- | --- |
| uid | num | 自己的uid |
| keyword | str | 搜索关键字 |
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ---------- | ------ | ---- |
| uid | num | 自己的mid | 必要 | |
| keyword | str | 搜索关键字 | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 |
| --- | --- | --- |
| code | num | 0成功 |
| msg | str | 成功为空文本 |
| message | str | 同msg |
| data | obj | 数据本体 |
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------------------------------------------------------------------------- |
| code | num | 返回值 | 0成功<br />1024系统开小差了<br />2001关键字不合法<br />7600001参数出错了请输入正确参数<br />7600008`uid`参数与自己的mid不匹配 |
| msg | str | 错误信息 | 成功为空文本 |
| message | str | 错误信息 | 同`msg` |
| data | obj | 数据本体 | |
data对象:
`data`对象:
| 字段 | 类型 | 内容 |
| --- | --- | --- |
| groups | obj[] | 内容分组(好像是根据关注列表分) |
| \_gt_ | num | 0 |
| 字段 | 类型 | 内容 | 备注 |
| ------ | ----- | -------- | -------------------------------------------- |
| groups | array | 用户分组 | 根据是否关注该用户来分组,未找到用户时无此项 |
| \_gt\_ | num | 0 | **作用尚不明确** |
group对象:
`groups`数组:
| 字段 | 类型 | 内容 |
| --- | --- | --- |
| group_type | num | 2:我的关注<br>4:其他 |
| group_name | str | 分组名字 |
| items | obj[] | 用户信息 |
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | --------- | ---- |
| 0 | obj | 分组1 | |
| n | obj | 分组(n+1) | |
| …… | obj | …… | …… |
item对象:
`groups`数组中的对象:
| 字段 | 类型 | 内容 |
| --- | --- | --- |
| uid | num | 用户id |
| uname | str | 用户昵称 |
| face | str | 用户头像url |
| fans | num | 用户粉丝数 |
| official_verify_type | num | 认证信息? |
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ----- | ---------------- | ------------------------ |
| group_type | num | 分组类型 | 2我的关注<br />4其他 |
| group_name | str | 分组名称 | `我的关注`或`其他` |
| items | array | 搜索到的用户信息 | 按照认证状态与粉丝数排序 |
<details>
<summary>查看示例</summary>
`items`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | --------- | ---- |
| 0 | obj | 用户1 | |
| n | obj | 用户(n+1) | |
| …… | obj | …… | …… |
`items`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------------------- | ---- | ------------ | ---------------------------------------- |
| uid | num | 用户mid | |
| uname | str | 用户昵称 | |
| face | str | 用户头像url | |
| fans | num | 用户粉丝数 | |
| official_verify_type | num | 用户认证状态 | -1<br />0个人认证<br />1机构认证 |
**示例:**
搜索关键字为`社会易`的用户
```shell
# 搜索关键字:社会易
curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858903&keyword=%e7%a4%be%e4%bc%9a%e6%98%93' \
-H 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:93.0) Gecko/20100101 Firefox/93.0' -H 'Accept: application/json, text/plain, */*' \
-H 'Referer: https://t.bilibili.com/' \
-H 'Cookie: SESSDATA=******'
curl -G 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search' \
--data-urlencode 'uid=15858903' \
--data-urlencode 'keyword=社会易' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
@ -77,7 +96,7 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
"uid": 293793435,
"uname": "社会易姐QwQ",
"face": "https://i0.hdslb.com/bfs/face/aebb2639a0d47f2ce1fec0631f412eaf53d4a0be.jpg",
"fans": 1179,
"fans": 3578,
"official_verify_type": -1
}
]
@ -87,24 +106,38 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
"group_name": "其他",
"items": [
{
"uid": 250129011,
"uname": "社会小伙肖子易",
"face": "https://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg",
"uid": 484031754,
"uname": "社会易老师",
"face": "https://i0.hdslb.com/bfs/face/dbc456bdec5e7a4806c9d0311d95ebcc6be674cf.jpg",
"fans": 21169,
"official_verify_type": -1
},
{
"uid": 442101413,
"uname": "社会李易儒",
"face": "https://i2.hdslb.com/bfs/face/311cecf9298158b8a5f47ed3e641328ab5c0cfcd.jpg",
"fans": 10,
"official_verify_type": -1
},
{
"uid": 3546589855484501,
"uname": "日本国立貿易株式会社",
"face": "https://i2.hdslb.com/bfs/face/2dad05e4748b5e91e1ec5d3c5d4f0904a5bcdaf0.jpg",
"fans": 7,
"official_verify_type": -1
},
{
"uid": 394873001,
"uname": "社会你易叔",
"face": "https://i2.hdslb.com/bfs/face/bde2811aa895e349036aba9ece5630bcd1341ff0.jpg",
"fans": 5,
"uid": 250129011,
"uname": "社会小伙肖子易",
"face": "https://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg",
"fans": 6,
"official_verify_type": -1
},
{
"uid": 486568790,
"uname": "社会主义接班人小易",
"face": "https://i2.hdslb.com/bfs/face/1ebb0d4aa8e2c4b532f82983503ec38b62a1820f.jpg",
"fans": 3,
"fans": 4,
"official_verify_type": -1
},
{
@ -114,13 +147,6 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
"fans": 2,
"official_verify_type": -1
},
{
"uid": 496622388,
"uname": "社会你易哥",
"face": "https://i0.hdslb.com/bfs/face/daac5514a7622741f767c68b1cbc6b91e60b4798.jpg",
"fans": 1,
"official_verify_type": -1
},
{
"uid": 457675287,
"uname": "易社会",
@ -129,10 +155,66 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
"official_verify_type": -1
},
{
"uid": 123270058,
"uname": "周易社会",
"face": "https://i1.hdslb.com/bfs/face/c6100396729112230deb3b0972db1504e9ce21bf.jpg",
"fans": 1,
"uid": 1602175830,
"uname": "不谦易会社恐",
"face": "https://i0.hdslb.com/bfs/face/de6afbda484e114b7cedeb621c3cbbaef7800988.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 155817540,
"uname": "社会易总",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 8,
"official_verify_type": -1
},
{
"uid": 3546578331634371,
"uname": "社会存在与社会易逝",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 1983403996,
"uname": "社会易姐QAQ",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 408471763,
"uname": "社会易大佬人狠话不多",
"face": "https://i1.hdslb.com/bfs/face/510cde8f4e3eb27aa50177d619a4200bb501797b.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 384672256,
"uname": "社会易轩",
"face": "https://i1.hdslb.com/bfs/face/7324adb53362527a1bf5f20141a6ae4307011ea7.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 284984452,
"uname": "社会易哥",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 249112673,
"uname": "社会易姐",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 0,
"official_verify_type": -1
},
{
"uid": 167967213,
"uname": "社会易大佬",
"face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
"fans": 0,
"official_verify_type": -1
}
]

View File

@ -943,7 +943,7 @@ curl -G 'https://api.bilibili.com/x/space/myinfo' \
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ----------------- | ------ | ------------------- |
| uids | nums | 目标用户的UID列表 | 必要 | 每个成员间用`,`分隔 |
| uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔 |
**json回复**
@ -1206,7 +1206,7 @@ curl -G 'https://api.bilibili.com/x/polymer/pc-electron/v1/user/cards' \
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ----------------- | ------ | --------------------------------------------------------------------- |
| uids | nums | 目标用户的UID列表 | 必要 | 每个成员间用`,`分隔最多50个成员若超过此限制则返回的`data`数组为空 |
| uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔最多50个成员若超过此限制则返回的`data`数组为空 |
**json回复**