优化文档格式

TMGT · Jun 8, 2020 · a73b238 · a73b238
1 parent ce5bab1
commit a73b238
Show file tree

Hide file tree

Showing 33 changed files with 238 additions and 238 deletions.
diff --git a/article/info.md b/article/info.md
@@ -6,11 +6,11 @@
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容     | 必要性 | 备注 |
 | ------ | ---- | -------- | ------ | ---- |
-| id     | url  | 专栏cvID | 必要   |      |
+| id     | num  | 专栏cvID | 必要   |      |
 
 **json回复：**
 

diff --git a/blackroom/banlist.md b/blackroom/banlist.md
@@ -1,6 +1,6 @@
 # 封禁用户公示
 
-**违规类型总览：**
+**已知的违规类型代码总览：**
 
 | 代码 | 含义                 |
 | ---- | -------------------- |
@@ -36,13 +36,13 @@
 
 每页最多10项
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容     | 必要性 | 备注                                                         |
 | ------ | ---- | -------- | ------ | ------------------------------------------------------------ |
-| btype  | url  | 来源筛选 | 非必要 | 空：全部类型<br />0：系统封禁<br />1：风纪仲裁               |
-| otype  | url  | 类型筛选 | 非必要 | 0：全部类型<br />1：评论<br />2：弹幕<br />3：私信<br />4：标签<br />5：个人资料<br />6：投稿<br />8：专栏<br />10：动态<br />11：相簿 |
-| pn     | url  | 页码     | 非必要 | 默认为1                                                      |
+| btype  | num  | 来源筛选 | 非必要 | 空：全部类型<br />0：系统封禁<br />1：风纪仲裁               |
+| otype  | num  | 类型筛选 | 非必要 | 0：全部类型<br />1：评论<br />2：弹幕<br />3：私信<br />4：标签<br />5：个人资料<br />6：投稿<br />8：专栏<br />10：动态<br />11：相簿 |
+| pn     | num  | 页码     | 非必要 | 默认为1                                                      |
 
 **json回复：**
 
@@ -170,11 +170,11 @@ http://api.bilibili.com/x/credit/blocked/list?btype=&otype=0&pn=1
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容       | 必要性 | 备注 |
 | ------ | ---- | ---------- | ------ | ---- |
-| id     | url  | 封禁公示ID | 必要   |      |
+| id     | num  | 封禁公示ID | 必要   |      |
 
 **json回复：**
 

diff --git a/broadcast/general.md b/broadcast/general.md
@@ -6,11 +6,11 @@
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名   | 类型 | 内容     | 必要性 | 备注                              |
 | -------- | ---- | -------- | ------ | --------------------------------- |
-| platform | url  | 平台选择 | 必要   | 为web时输出域名<br />其他时输出ip |
+| platform | str  | 平台选择 | 必要   | 为web时输出域名<br />其他时输出ip |
 
 **json回复：**
 

diff --git a/cheese/info.md b/cheese/info.md
@@ -18,12 +18,12 @@
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名    | 类型 | 内容     | 必要性 | 备注                                               |
 | --------- | ---- | -------- | ------ | -------------------------------------------------- |
-| season_id | url  | 课程ssID | 非必要 | season_id与ep_id任选其一<br />**与番剧ssID不互通** |
-| ep_id     | url  | 课程epID | 非必要 | season_id与ep_id任选其一<br />**与番剧epID不互通** |
+| season_id | num  | 课程ssID | 非必要 | season_id与ep_id任选其一<br />**与番剧ssID不互通** |
+| ep_id     | num  | 课程epID | 非必要 | season_id与ep_id任选其一<br />**与番剧epID不互通** |
 
 **json回复：**
 
@@ -444,13 +444,13 @@ http://api.bilibili.com/pugv/view/web/season?season_id=61
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名    | 类型 | 内容     | 必要性 | 备注                 |
 | --------- | ---- | -------- | ------ | -------------------- |
-| season_id | url  | 课程ssID | 必要   | **与番剧ssID不互通** |
-| ps        | url  | 每页项数 | 非必要 | 默认为50             |
-| pn        | url  | 页码     | 非必要 | 默认为1              |
+| season_id | num  | 课程ssID | 必要   | **与番剧ssID不互通** |
+| ps        | num  | 每页项数 | 非必要 | 默认为50             |
+| pn        | num  | 页码     | 非必要 | 默认为1              |
 
 **json回复：**
 

diff --git a/cheese/videostream_url.md b/cheese/videostream_url.md
@@ -16,14 +16,14 @@
 
 **部分视频**会有**分段**，需要特别注意
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容           | 必要性 | 备注                                                         |
 | ------ | ---- | -------------- | ------ | ------------------------------------------------------------ |
-| aid    | url  | 课程avID       | 必要   |                                                              |
-| ep_id  | url  | 课程epID       | 必要   |                                                              |
-| cid    | url  | 视频CID        | 必要   |                                                              |
-| qn     | url  | 视频清晰度选择 | 非必要 | 未登录默认32（480P）<br />登录默认64（720P）<br />**值含义见下表** |
+| aid    | num  | 课程avID       | 必要   |                                                              |
+| ep_id  | num  | 课程epID       | 必要   |                                                              |
+| cid    | num  | 视频CID        | 必要   |                                                              |
+| qn     | num  | 视频清晰度选择 | 非必要 | 未登录默认32（480P）<br />登录默认64（720P）<br />**值含义见下表** |
 
 分辨率代码：
 

diff --git a/creativecenter/statistics&data.md b/creativecenter/statistics&data.md
@@ -226,11 +226,11 @@ http://member.bilibili.com/x/web/data/article
 
 数据为前30天
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容         | 必要性 | 备注           |
 | ------ | ---- | ------------ | ------ | -------------- |
-| type   | url  | 目标数据类型 | 必要   | 类型代码见下表 |
+| type   | num  | 目标数据类型 | 必要   | 类型代码见下表 |
 
 类型代码`type`：
 
@@ -317,11 +317,11 @@ http://member.bilibili.com/x/web/data/pandect?type=1
 
 数据为前30天
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容         | 必要性 | 备注           |
 | ------ | ---- | ------------ | ------ | -------------- |
-| type   | url  | 目标数据类型 | 必要   | 类型代码见下表 |
+| type   | num  | 目标数据类型 | 必要   | 类型代码见下表 |
 
 类型代码`type`：
 
@@ -403,11 +403,11 @@ http://member.bilibili.com/x/web/data/article/thirty?type=1
 
 数据为上一天的
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容         | 必要性 | 备注           |
 | ------ | ---- | ------------ | ------ | -------------- |
-| type   | url  | 目标数据类型 | 必要   | 类型代码见下表 |
+| type   | num  | 目标数据类型 | 必要   | 类型代码见下表 |
 
 类型代码`type`：
 

diff --git a/danmaku/action.md b/danmaku/action.md
@@ -8,22 +8,22 @@
 
 需要登录(SESSDATA)
 
-**参数（ application/x-www-form-urlencoded ）：**
+**正文参数（ application/x-www-form-urlencoded ）：**
 
 | 参数名   | 类型 | 内容                   | 必要性 | 备注                                                         |
 | -------- | ---- | ---------------------- | ------ | ------------------------------------------------------------ |
-| type     | data | 1                      | 必要   |                                                              |
-| oid      | data | 视频CID                | 必要   |                                                              |
-| msg      | data | 弹幕内容               | 必要   | 长度小于100字符                                              |
-| bvid     | data | 视频bvID               | 非必要 | avID与bvID任选一个                                           |
-| aid      | data | 视频avID               | 非必要 | avID与bvID任选一个                                           |
-| progress | data | 弹幕出现在视频内的时间 | 非必要 | 单位为毫秒<br />默认为0                                      |
-| color    | data | 弹幕颜色设置           | 非必要 | 详见[「弹幕」中的属性 p](danmaku.md#属性 p)<br />默认为16777215（#FFFFFF）白色 |
-| fontsize | data | 弹幕字号设置           | 非必要 | 详见[「弹幕」中的属性 p](danmaku.md#属性 p)<br />默认为25    |
-| pool     | data | 弹幕池选择             | 非必要 | 0：普通弹幕<br />1：字幕弹幕<br />2：BAS弹幕<br />默认为0    |
-| mode     | data | 弹幕类型选择           | 必要   | 1：普通<br />4：底部<br />5：顶部<br />7：高级<br />9：BAS（`pool`必须为2） |
-| rnd      | data | 16位10进制随机数       | 非必要 | **若无此项，则发送弹幕冷却时间限制为90s**<br />若有此项，则发送弹幕冷却时间限制为5s |
-| csrf     | data | cookies中的bili_jct    | 必要   |                                                              |
+| type     | num  | 1                      | 必要   |                                                              |
+| oid      | num  | 视频CID                | 必要   |                                                              |
+| msg      | str  | 弹幕内容               | 必要   | 长度小于100字符                                              |
+| bvid     | str  | 视频bvID               | 非必要 | avID与bvID任选一个                                           |
+| aid      | num  | 视频avID               | 非必要 | avID与bvID任选一个                                           |
+| progress | num  | 弹幕出现在视频内的时间 | 非必要 | 单位为毫秒<br />默认为0                                      |
+| color    | num  | 弹幕颜色设置           | 非必要 | 详见[「弹幕」中的属性 p](danmaku.md#属性 p)<br />默认为16777215（#FFFFFF）白色 |
+| fontsize | num  | 弹幕字号设置           | 非必要 | 详见[「弹幕」中的属性 p](danmaku.md#属性 p)<br />默认为25    |
+| pool     | num  | 弹幕池选择             | 非必要 | 0：普通弹幕<br />1：字幕弹幕<br />2：BAS弹幕<br />默认为0    |
+| mode     | num  | 弹幕类型选择           | 必要   | 1：普通<br />4：底部<br />5：顶部<br />7：高级<br />9：BAS（`pool`必须为2） |
+| rnd      | num  | 16位10进制随机数       | 非必要 | **若无此项，则发送弹幕冷却时间限制为90s**<br />若有此项，则发送弹幕冷却时间限制为5s |
+| csrf     | str  | cookies中的bili_jct    | 必要   |                                                              |
 
 **json回复：**
 
@@ -79,13 +79,13 @@ curl -b "SESSDATA=xxx" -d "type=1&oid=62131&msg=%e5%89%8d%e6%9d%a5%e8%80%83%e5%8
 
 需要登录(SESSDATA)
 
-**参数（ application/x-www-form-urlencoded ）：**
+**正文参数（ application/x-www-form-urlencoded ）：**
 
 | 参数名 | 类型 | 内容                | 必要性 | 备注 |
 | ------ | ---- | ------------------- | ------ | ---- |
-| dmid   | data | 弹幕ID              | 必要   |      |
-| cid    | data | 视频CID             | 必要   |      |
-| csrf   | data | cookies中的bili_jct | 必要   |      |
+| dmid   | num  | 弹幕ID              | 必要   |      |
+| cid    | num  | 视频CID             | 必要   |      |
+| csrf   | str  | cookies中的bili_jct | 必要   |      |
 
 **json回复：**
 
@@ -122,13 +122,13 @@ curl -b "SESSDATA=xxx" -d "dmid=32310301474947077&cid=168901231&csrf=xxx" "http:
 
 购买一次需要2硬币，同时向up主发送请求
 
-**参数（ application/x-www-form-urlencoded ）：**
+**正文参数（ application/x-www-form-urlencoded ）：**
 
 | 参数名 | 类型 | 内容                | 必要性 | 备注 |
 | ------ | ---- | ------------------- | ------ | ---- |
-| mode   | data | sp                  | 必要   |      |
-| cid    | data | 视频CID             | 必要   |      |
-| csrf   | data | cookies中的bili_jct | 必要   |      |
+| mode   | str  | sp                  | 必要   |      |
+| cid    | num  | 视频CID             | 必要   |      |
+| csrf   | str  | cookies中的bili_jct | 必要   |      |
 
 **json回复：**
 
@@ -163,12 +163,12 @@ curl -b "SESSDATA=xxx" -d "mode=sp&cid=168901231&csrf=xxx" "http://api.bilibili.
 
 需要登录(SESSDATA)
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容    | 必要性 | 备注 |
 | ------ | ---- | ------- | ------ | ---- |
-| mode   | url  | sp      | 必要   |      |
-| cid    | url  | 视频CID | 必要   |      |
+| mode   | str  | sp      | 必要   |      |
+| cid    | num  | 视频CID | 必要   |      |
 
 **json回复：**
 

diff --git a/danmaku/danmaku.md b/danmaku/danmaku.md
@@ -12,11 +12,11 @@
 
 **使用deflate压缩，注意解码**
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容    | 必要性 | 备注 |
 | ------ | ---- | ------- | ------ | ---- |
-| oid    | url  | 视频CID | 必要   |      |
+| oid    | num  | 视频CID | 必要   |      |
 
 **示例：**
 
@@ -32,11 +32,11 @@ http://api.bilibili.com/x/v1/dm/list.so?oid=144541892
 
 **使用deflate压缩，注意解码**
 
-**参数：**
+**url：**
 
 | 参数名 | 类型 | 内容    | 必要性 | 备注 |
 | ------ | ---- | ------- | ------ | ---- |
-| cid    | url  | 视频CID | 必要   |      |
+| cid    | num  | 视频CID | 必要   |      |
 
 **示例：**
 

diff --git a/danmaku/history.md b/danmaku/history.md
@@ -8,13 +8,13 @@
 
 *方式：GET*
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容     | 必要性 | 备注         |
 | ------ | ---- | -------- | ------ | ------------ |
-| type   | url  | 1        | 必要   | 作用尚不明确 |
-| oid    | url  | 视频CID  | 必要   |              |
-| month  | url  | 查询月份 | 必要   | mm-dd        |
+| type   | num  | 1        | 必要   | 作用尚不明确 |
+| oid    | num  | 视频CID  | 必要   |              |
+| month  | str  | 查询月份 | 必要   | mm-dd        |
 
 **json回复：**
 
@@ -85,13 +85,13 @@ http://api.bilibili.com/x/v2/dm/history/index?type=1&oid=144541892&month=2019-12
 
 **使用deflate压缩，注意解码**
 
-**参数：**
+**url参数：**
 
 | 参数名 | 类型 | 内容     | 必要性 | 备注         |
 | ------ | ---- | -------- | ------ | ------------ |
-| type   | url  | 1        | 必要   | 作用尚不明确 |
-| oid    | url  | 视频CID  | 必要   |              |
-| date   | url  | 弹幕日期 | 必要   | yyyy-mm-dd   |
+| type   | num  | 1        | 必要   | 作用尚不明确 |
+| oid    | num  | 视频CID  | 必要   |              |
+| date   | str  | 弹幕日期 | 必要   | yyyy-mm-dd   |
 
 **示例：**
 

diff --git a/danmaku/snapshot.md b/danmaku/snapshot.md
@@ -8,11 +8,11 @@
 
 最近产生的几条弹幕内容，**最多20条**
 
-**参数：**
+**url参数：**
 
-| 参数名 | 类型 | 内容               | 必要性 | 备注 |
-| ------ | ---- | ------------------ | ------ | ---- |
-| aid    | url  | 视频avID或视频bvID | 必要   |      |
+| 参数名 | 类型     | 内容               | 必要性 | 备注 |
+| ------ | -------- | ------------------ | ------ | ---- |
+| aid    | num或str | 视频avID或视频bvID | 必要   |      |
 
 **json回复：**
 

diff --git a/dynamic/publish.md b/dynamic/publish.md
@@ -12,12 +12,12 @@
 
 注意：非日常类型像素宽高必须大于420
 
-**参数（multipart/form-data）：**
+**正文参数（multipart/form-data）：**
 
 | 参数名   | 类型 | 内容               | 必要性 | 备注                                                         |
 | -------- | ---- | ------------------ | ------ | ------------------------------------------------------------ |
-| file_up  | data | 需要上传的图片文件 | 必要   | 格式仅支持jpg  png  gif                                      |
-| category | data | 图片类型           | 必要   | daily：日常（动态）<br />draw：绘画（画友）<br />cos：摄影（COSPLAY） |
+| file_up  | file | 需要上传的图片文件 | 必要   | 格式仅支持jpg  png  gif                                      |
+| category | str  | 图片类型           | 必要   | daily：日常（动态）<br />draw：绘画（画友）<br />cos：摄影（COSPLAY） |
 
 **json回复：**
 

diff --git a/electric/Bcoin.md b/electric/Bcoin.md
@@ -10,15 +10,15 @@
 
 需要登录(SESSDATA)
 
-**参数（ application/x-www-form-urlencoded ）：**
+**正文参数（ application/x-www-form-urlencoded ）：**
 
 | 参数名   | 类型 | 内容                | 必要性 | 备注                                              |
 | -------- | ---- | ------------------- | ------ | ------------------------------------------------- |
-| elec_num | data | 充电电池数量        | 必要   | 必须在20-99990之间                                |
-| up_mid   | data | 充电对象用户UID     | 必要   |                                                   |
-| otype    | data | 充电来源            | 必要   | up：空间充电<br />archive：视频充电               |
-| oid      | data | 充电来源代码        | 必要   | 空间充电：充电对象用户UID<br />视频充电：视频avID |
-| csrf     | data | cookies中的bili_jct | 必要   |                                                   |
+| elec_num | num  | 充电电池数量        | 必要   | 必须在20-99990之间                                |
+| up_mid   | num  | 充电对象用户UID     | 必要   |                                                   |
+| otype    | str  | 充电来源            | 必要   | up：空间充电<br />archive：视频充电               |
+| oid      | num  | 充电来源代码        | 必要   | 空间充电：充电对象用户UID<br />视频充电：视频avID |
+| csrf     | str  | cookies中的bili_jct | 必要   |                                                   |
 
 **json回复：**
 
@@ -37,15 +37,15 @@
 | -------- | ---- | ----------- | ------------------------------------------------ |
 | mid      | num  | 本用户UID   |                                                  |
 | up_mid   | num  | 目标用户UID |                                                  |
-| order_no | str  | 交易编号    | 用于添加充电备注                                 |
+| order_no | str  | 留言token   | 用于添加充电留言                                 |
 | elec_num | num  | 充电电池数  |                                                  |
 | exp      | num  | 获得经验数  |                                                  |
 | status   | num  | 返回结果    | 4：成功<br />-2：低于20电池下限<br />-4：B币不足 |
 | msg      | str  | 错误信息    | 默认为空                                         |
 
 **示例：**
 
-以空间的方式向用户`UID=293793435`充了20电池，得到2经验，交易编号为`BPRG5CEC3VUPOOANA540`
+以空间的方式向用户`UID=293793435`充了20电池，得到2经验，留言token为`BPRG5CEC3VUPOOANA540`
 
 此时`data`.`status`=`4`