- 開發(fā)過程中經(jīng)常需要整理接口并且寫一份接口文檔融欧，這是使用MarkDown寫的一份示例鸽凶，先預(yù)覽下樣子：
接口列表
| 接口 | 說明 |
|---|---|
| /p/global/strategy | 請求全局策略 |
| /p/user/userLogin | 用戶登錄接口 |
錯誤碼列表
| 錯誤碼 | 說明 |
|---|---|
| 0 | 正確 |
| 1 | 錯誤 |
| 2 | 參數(shù)錯誤 |
接口詳情
-
全局策略
接口地址：/p/global/strategy
返回格式：Json
請求方式：Post
接口備注：通過用戶信息膘怕，請求獲得全局策略。
-
請求參數(shù)說明：
名稱 類型 必填 說明 marking string true 企業(yè)標(biāo)識 account string true 用戶名 pw string true 用戶密碼 -
返回參數(shù)說明：
名稱 類型 說明 rt int 狀態(tài)碼 data object 具體數(shù)據(jù) identify_method int 登錄方式 send_url string 推送地址 -
JSON返回示例：
{ "rt": 0, "data": { "identify_method": "3", "send_url": "www.reibang.com" } }
-
登錄接口
接口地址：/p/global/login
返回格式：Json
請求方式：Post
接口備注：通過用戶信息，請求獲得全局策略者铜。
-
請求參數(shù)說明：
名稱 類型 必填 說明 marking string true 企業(yè)標(biāo)識 account string true 用戶名 pw string true 用戶密碼 -
返回參數(shù)說明：
名稱 類型 說明 rt int 狀態(tài)碼 data object 具體數(shù)據(jù) identify_method int 登錄方式 send_url string 推送地址 -
JSON返回示例：
{ "rt": 0, "data": { "identify_method": "3", "send_url": "www.reibang.com" } }
- 在簡書的MarkDown編輯器中不支持部分標(biāo)簽趁俊，如不支持錨點(diǎn)：<span></span>域仇，顏色：<font color=red>等，預(yù)覽效果是刪除了這部分寺擂。
- MarkDown的語法
- 初始文件：
## 接口列表
| 接口 | 說明 |
|------ |----- |
|[/p/global/strategy](#strategy)| 請求全局策略|
|[/p/user/userLogin](#login) | 用戶登錄接口|
***
##錯誤碼列表
| 錯誤碼 | 說明 |
|------ |----- |
| 0 | 正確 |
| 1 | 錯誤 |
| 2 | 參數(shù)錯誤|
## 接口詳情
* <span id = "strategy">全局策略</span>
* 接口地址：/p/global/strategy
* 返回格式：Json
* 請求方式：Post
* 請求示例：http://www.baidu.com/p/global/strategy
* 接口備注：通過用戶信息暇务，請求獲得全局策略。
* 請求參數(shù)說明：
| 名稱 | 類型 | 必填 |說明|
|----- |------| ---- |----|
|marking |string|true|企業(yè)標(biāo)識|
|<font color=red>account | string |true|用戶名|
|<font color=red>pw | string |true|用戶密碼|
* 返回參數(shù)說明：
| 名稱 | 類型 |說明|
|----- |------|----|
| rt | int|狀態(tài)碼
|data | object|具體數(shù)據(jù)|
|identify_method | int|登錄方式|
|send_url | string|推送地址|
* JSON返回示例：
{
"rt": 0,
"data": {
"identify_method": "3",
"send_url": "www.reibang.com"
}
}
---
* <span id = "login">登錄接口</span>
* 接口地址：/p/global/login
* 返回格式：Json
* 請求方式：Post
* 請求示例：http://www.baidu.com/p/global/strategy
* 接口備注：通過用戶信息怔软，請求獲得全局策略垦细。
* 請求參數(shù)說明：
| 名稱 | 類型 | 必填 |說明|
|----- |------| ---- |----|
|marking |string|true|企業(yè)標(biāo)識|
|<font color=red>account | string |true|用戶名|
|<font color=red>pw | string |true|用戶密碼|
* 返回參數(shù)說明：
| 名稱 | 類型 |說明|
|----- |------|----|
| rt | int|狀態(tài)碼
|data | object|具體數(shù)據(jù)|
|identify_method | int|登錄方式|
|send_url | string|推送地址|
* JSON返回示例：
{
"rt": 0,
"data": {
"identify_method": "3",
"send_url": "www.reibang.com"
}
}
---
