优化文档格式

2020-07-14 18:44:44 +08:00
parent 08f1671e6c
commit f272277d22
63 changed files with 1724 additions and 424 deletions
--- a/login/login_action/QR.md
+++ b/login/login_action/QR.md
@@ -17,7 +17,7 @@

 > http://passport.bilibili.com/qrcode/getLoginUrl

-*方式：GET*
+*请求方式：GET*

 密钥超时为180秒

@@ -43,7 +43,10 @@

 用申请到的`data`.`url`中的值生成二维码，等待手机客户端扫描，并将`data`.`oauthKey`保存等待使用

-http://passport.bilibili.com/qrcode/getLoginUrl
+```shell
+curl 'http://passport.bilibili.com/qrcode/getLoginUrl'
+```
+
 ```json
 {
 	"code": 0,
@@ -56,13 +59,11 @@ http://passport.bilibili.com/qrcode/getLoginUrl
 }
 ```

-
-
-## 验证二维码登录 
+## 使用扫码登录（验证扫码状态）

 > http://passport.bilibili.com/qrcode/getLoginInfo

-*方式：POST*
+*请求方式：POST*

 密钥超时为180秒

@@ -96,7 +97,13 @@ data 对象：

 **示例：**

-curl -d "oauthKey=xxx" "http://passport.bilibili.com/qrcode/getLoginInfo"
+例如扫码秘钥为`23333`
+
+```shell
+curl "http://passport.bilibili.com/qrcode/getLoginInfo"\
+--data-urlencode 'oauthKey=23333'\
+-c 'cookie.txt'
+```

 当密钥正确时但未扫描时`status`为`false`，`data`为num值`-4`

--- a/login/login_action/SMS.md
+++ b/login/login_action/SMS.md
@@ -10,7 +10,7 @@ web端短信登录流程：

 > http://passport.bilibili.com/web/generic/country/list

-*方式：GET*
+*请求方式：GET*

 **json回复：**

@@ -90,7 +90,7 @@ curl 'http://passport.bilibili.com/web/generic/country/list'

 > http://passport.bilibili.com/web/sms/general/v2/send

-*方式：POST*
+*请求方式：POST*

 短信发送CD时间为60s

@@ -123,7 +123,7 @@ curl 'http://passport.bilibili.com/web/generic/country/list'
 例如手机号为`13888888888`，国际ID为`1（中国大陆）`，登录秘钥为`aabbccdd`，极验challenge为`2333`，极验结果为`666666`，进行发送短信验证码操作

 ```shell
-curl --request POST 'http://passport.bilibili.com/web/sms/general/v2/send' \
+curl 'http://passport.bilibili.com/web/sms/general/v2/send' \
 --data-urlencode 'tel=13888888888'\
 --data-urlencode 'cid=1'\
 --data-urlencode 'type=21'\
@@ -140,11 +140,11 @@ curl --request POST 'http://passport.bilibili.com/web/sms/general/v2/send' \
 }
 ```

-## 验证短信登录操作（web端）
+## 使用短信验证码登录（web端）

 > http://passport.bilibili.com/web/login/rapid

-*方式：POST*
+*请求方式：POST*

 验证登录成功后会进行设置以下cookie项：

@@ -182,7 +182,7 @@ curl --request POST 'http://passport.bilibili.com/web/sms/general/v2/send' \
 使用手机号`13888888888`，短信验证码为`123456`，进行验证登录操作

 ```shell
-curl --request POST 'https://passport.bilibili.com/web/login/rapid' 
+curl 'https://passport.bilibili.com/web/login/rapid' 
 --data-urlencode 'cid=1'\
 --data-urlencode 'tel=13888888888'\
 --data-urlencode 'smsCode=123456'
--- a/login/login_action/password.md
+++ b/login/login_action/password.md
@@ -10,7 +10,7 @@ web端密码登录流程：

 > http://passport.bilibili.com/login?act=getkey

-*方式：GET*
+*请求方式：GET*

 **json回复：**

@@ -38,7 +38,7 @@ curl 'http://passport.bilibili.com/login?act=getkey'

 >  http://passport.bilibili.com/api/oauth2/getKey

-*方式：POST*
+*请求方式：POST*

 **正文参数（ application/x-www-form-urlencoded ）：**

@@ -59,7 +59,7 @@ curl 'http://passport.bilibili.com/login?act=getkey'
 **示例：**

 ```shell
-curl --request POST 'http://passport.bilibili.com/api/oauth2/getKey'\
+curl 'http://passport.bilibili.com/api/oauth2/getKey'\
 --data-urlencode 'appkey=1d8b6e7d45233436'\
 --data-urlencode 'sign=17004c193f688f0b5665c1068e733aff'
 ```
@@ -75,7 +75,7 @@ curl --request POST 'http://passport.bilibili.com/api/oauth2/getKey'\

 **注：RSA公钥一般为固定值**

-```plaintext
+```
 -----BEGIN PUBLIC KEY-----
 MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjb4V7EidX/ym28t2ybo0U6t0n
 6p4ej8VjqKHg100va6jkNbNTrLQqMCQCAYtXMXXp2Fwkk6WR+12N9zknLjf+C9sx
@@ -86,19 +86,19 @@ Xl69GV6klzgxW6d2xQIDAQAB

 例如登录密码为：

-```plaintext
+```
 BiShi22332323
 ```

 获取到的盐值为：

-```plaintext
+```
 8e0db05c46f4052c
 ```

 那么按照`盐值`+`密码字串`连接二者得到：

-```plaintext
+```
 8e0db05c46f4052cBiShi22332323
 ```

@@ -106,15 +106,15 @@ BiShi22332323

 因为公钥的**无法解密性**和盐值的**超时机制**，故无法本地验证加密结果

-```plaintext
+```
 YgpjxAQ22pKa9socHIKPCZX0a/NS6Ng9Zzy+rp16b0LJGT6RHw2ERs3+ijCpG96PKTY1Baavwf0xgotmNvpl25l1KO5y4AjcqeWTzNTSVn6ejonBXGmBMybHHYawJ0aMPn1eDGpKrbI91mrF+h2x+fsnnpuZ1gheiYGzFmtshUc=
 ```

-## 验证密码登录操作（web端）
+## 使用账号密码登录（web端）

 > http://passport.bilibili.com/web/login/v2

-*方式：POST*
+*请求方式：POST*

 验证登录成功后会进行设置以下cookie项：

@@ -164,7 +164,7 @@ YgpjxAQ22pKa9socHIKPCZX0a/NS6Ng9Zzy+rp16b0LJGT6RHw2ERs3+ijCpG96PKTY1Baavwf0xgotm
 例如用户账号为`12345678900`，加密后的密码为`xxx`，登录秘钥为`aabbccdd`，极验challenge为`2333`，极验结果为`666666`，进行验证登录操作

 ```shell
-curl --request POST 'https://passport.bilibili.com/web/login/v2'\
+curl 'https://passport.bilibili.com/web/login/v2'\
 --data-urlencode 'captchaType=6'\
 --data-urlencode 'username=12345678900'\
 --data-urlencode 'password=xxx'\
--- a/login/login_action/readme.md
+++ b/login/login_action/readme.md
@@ -1,7 +1,15 @@
-# 验证码登录
+# 登录操作

 人机验证方式登录包含**账号密码登录**与手**机短信验证码登录**

+**注：扫码登录**不需要进行**人机验证**，故**不使用**以下接口
+
+## 扫码登录
+
+- [扫码登录](QR.md)
+
+## 验证登录
+
 人机验证流程：

 1. 请求验证码参数，得到登录密钥`key`与极验ID`gt`和极验KEY`challenge`
@@ -9,11 +17,11 @@
 3. 返回验证结果`validate`与`seccode`，进行短信或密码登录


-## 申请验证码参数
+### 申请验证码参数

 > http://passport.bilibili.com/web/captcha/combine?plat=6

-*方式：GET*
+*请求方式：GET*

 **json回复：**

@@ -61,7 +69,7 @@ curl 'https://passport.bilibili.com/web/captcha/combine?plat=6'
 ```


-## 进行验证
+### 进行验证

 本文档为Bilibili文档，验证码为geetest极验提供，故不提供api

@@ -74,7 +82,7 @@ curl 'https://passport.bilibili.com/web/captcha/combine?plat=6'
 4. 使用最开始获得到的`key`、`challenge`和刚获得到的`validate`、`seccode`继续之后的登录操作


-## 继续登录
+### 继续登录

 - [短信登录](SMS.md)
 - [密码登录](password.md)
--- a/login/login_info.md
+++ b/login/login_info.md
@@ -8,7 +8,7 @@
 >
 > http://api.bilibili.com/x/web-interface/nav (原始数据)

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -179,7 +179,7 @@ http://api.bilibili.com/x/web-interface/nav

 > http://account.bilibili.com/home/userInfo

-*方式:GET*
+*请求方式：GET*

 需要验证DedeUserID存在且不为0

@@ -257,7 +257,7 @@ http://account.bilibili.com/home/userInfo

 > http://api.bilibili.com/x/web-interface/nav/stat

-*方式：GET*
+*请求方式：GET*

 **json回复：**

--- a/login/member_center.md
+++ b/login/member_center.md
@@ -6,7 +6,7 @@

 > http://api.bilibili.com/x/member/web/account

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -60,7 +60,7 @@ http://api.bilibili.com/x/member/web/account

 > http://api.bilibili.com/x/member/web/exp/reward

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -114,7 +114,7 @@ http://api.bilibili.com/x/member/web/exp/reward

 > http://api.bilibili.com/x/vip/web/user/info

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -164,7 +164,7 @@ http://api.bilibili.com/x/vip/web/user/info

 > http://passport.bilibili.com/web/site/user/info

-*方式:GET*
+*请求方式：GET*

 需要验证`DedeUserID`存在且不为0

@@ -260,7 +260,7 @@ http://passport.bilibili.com/web/site/user/info

 > http://api.bilibili.com/x/member/realname/status

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -302,7 +302,7 @@ http://api.bilibili.com/x/member/realname/status

 > http://api.bilibili.com/x/member/realname/apply/status

-*方式:GET*
+*请求方式：GET*

 **json回复：**

@@ -348,7 +348,7 @@ http://api.bilibili.com/x/member/realname/apply/status

 > http://api.bilibili.com/x/member/web/coin/log

-*方式:GET*
+*请求方式：GET*

 仅能查询最近一周的情况