• 開(kāi)發(fā)過(guò)程中經(jīng)常需要整理接口并且寫一份接口文檔，這是使用MarkDown寫的一份示例，先預(yù)覽下樣子：

接口列表

錯(cuò)誤碼列表

接口詳情

• 全局策略

  • 接口地址：/p/global/strategy

  • 返回格式：Json

  • 請(qǐng)求方式：Post

  • 請(qǐng)求示例：http://www.baidu.com/p/global/strategy

  • 接口備注：通過(guò)用戶信息，請(qǐng)求獲得全局策略。

  • 請(qǐng)求參數(shù)說(shuō)明：

    名稱	類型	必填	說(shuō)明
    marking	string	true	企業(yè)標(biāo)識(shí)
    account	string	true	用戶名
    pw	string	true	用戶密碼

  • 返回參數(shù)說(shuō)明：

    名稱	類型	說(shuō)明
    rt	int	狀態(tài)碼
    data	object	具體數(shù)據(jù)
    identify_method	int	登錄方式
    send_url	string	推送地址

  • JSON返回示例：

       {
           "rt": 0,
           "data": {
               "identify_method": "3",
               "send_url": "www.itdecent.cn"
           }
       }
    

• 登錄接口

  • 接口地址：/p/global/login

  • 返回格式：Json

  • 請(qǐng)求方式：Post

  • 請(qǐng)求示例：http://www.baidu.com/p/global/login

  • 接口備注：通過(guò)用戶信息，請(qǐng)求獲得全局策略。

  • 請(qǐng)求參數(shù)說(shuō)明：

    名稱	類型	必填	說(shuō)明
    marking	string	true	企業(yè)標(biāo)識(shí)
    account	string	true	用戶名
    pw	string	true	用戶密碼

  • 返回參數(shù)說(shuō)明：

    名稱	類型	說(shuō)明
    rt	int	狀態(tài)碼
    data	object	具體數(shù)據(jù)
    identify_method	int	登錄方式
    send_url	string	推送地址

  • JSON返回示例：

       {
           "rt": 0,
           "data": {
               "identify_method": "3",
               "send_url": "www.itdecent.cn"
           }
       }
    

• 在簡(jiǎn)書的MarkDown編輯器中不支持部分標(biāo)簽，如不支持錨點(diǎn)：<span></span>，顏色：<font color=red>等，預(yù)覽效果是刪除了這部分。
• MarkDown的語(yǔ)法
• 初始文件：

 ## 接口列表

|  接口  | 說(shuō)明 |
|------ |----- |
|[/p/global/strategy](#strategy)| 請(qǐng)求全局策略|
|[/p/user/userLogin](#login) | 用戶登錄接口|

***
##錯(cuò)誤碼列表
|  錯(cuò)誤碼  | 說(shuō)明 |
|------ |----- |
|   0   | 正確 |
|   1   | 錯(cuò)誤 |
|   2   | 參數(shù)錯(cuò)誤|

## 接口詳情
* <span id = "strategy">全局策略</span>

    * 接口地址：/p/global/strategy

    * 返回格式：Json

    * 請(qǐng)求方式：Post

    * 請(qǐng)求示例：http://www.baidu.com/p/global/strategy

    * 接口備注：通過(guò)用戶信息，請(qǐng)求獲得全局策略。

    * 請(qǐng)求參數(shù)說(shuō)明：

        | 名稱 | 類型 | 必填 |說(shuō)明|
        |----- |------| ---- |----|
        |marking |string|true|企業(yè)標(biāo)識(shí)|
        |<font color=red>account | string |true|用戶名|
        |<font color=red>pw | string |true|用戶密碼|

    * 返回參數(shù)說(shuō)明：

        | 名稱 | 類型 |說(shuō)明|
        |----- |------|----|
        | rt | int|狀態(tài)碼
        |data | object|具體數(shù)據(jù)|
        |identify_method | int|登錄方式|
        |send_url | string|推送地址|

    * JSON返回示例：

             {
                 "rt": 0,
                 "data": {
                     "identify_method": "3",
                     "send_url": "www.itdecent.cn"
                 }
             }


---

* <span id = "login">登錄接口</span>

    * 接口地址：/p/global/login

    * 返回格式：Json

    * 請(qǐng)求方式：Post

    * 請(qǐng)求示例：http://www.baidu.com/p/global/strategy

    * 接口備注：通過(guò)用戶信息，請(qǐng)求獲得全局策略。

    * 請(qǐng)求參數(shù)說(shuō)明：

        | 名稱 | 類型 | 必填 |說(shuō)明|
        |----- |------| ---- |----|
        |marking |string|true|企業(yè)標(biāo)識(shí)|
        |<font color=red>account | string |true|用戶名|
        |<font color=red>pw | string |true|用戶密碼|

    * 返回參數(shù)說(shuō)明：

        | 名稱 | 類型 |說(shuō)明|
        |----- |------|----|
        | rt | int|狀態(tài)碼
        |data | object|具體數(shù)據(jù)|
        |identify_method | int|登錄方式|
        |send_url | string|推送地址|

    * JSON返回示例：

             {
                 "rt": 0,
                 "data": {
                     "identify_method": "3",
                     "send_url": "www.itdecent.cn"
                 }
             }


---