最近在tower上用markdown編寫了項目的API文檔，感覺挺好用。
主要利用錨點跳轉到接口詳情。tower在生產html的時候會在標題標簽內加入id，如
* #### users/mobile
* ## ErrorCode
轉換為
<h4 id="users-mobile">users/mobile</h4>
<h2 id="errorcode">ErrorCode</h2>
用戶信息接口列表
讀取接口
| users/mobile | 獲取用戶手機號 |
寫入接口
| users/mobile/put | 上傳用戶手機號 |
用戶信息接口詳情
-
users/mobile
獲取用戶手機號
是否需要權限驗證
是
請求參數
| | 必選 | 類型 | 說明 |
|:-------------:|:-------------|:-------------|
| userId | true | int | 用戶ID |
請求方法
GET
調用樣例
users/mobile?userId=214
返回結果
*** JSON示例 ***
{
"code": 0,
"msg": "",
"data": {
"mobile": 150888888888
}
}
*** 錯誤返回值 ***
| code | msg | 說明 |
|:-------------:|:-------------|
| 1010 | xxxx | xxxx |
關于其它錯誤返回值與錯誤代碼，參見 錯誤代碼說明
ErrorCode
錯誤代碼對照表
系統級錯誤
| 錯誤代碼 | 返回msg | 詳細描述 |
|:-------------:|:-------------|
| 400 | 系統錯誤，請稍候再試 | 請求參數有誤 |
| 401 | 系統錯誤，請稍候再試 | 用戶未登錄 |
| 404 | 系統錯誤，請稍候再試 | 資源未找到 |
| 405 | 系統錯誤，請稍候再試 | 請求方法不支持 |
| 500 | 系統錯誤，請稍候再試 | 服務器錯誤 |
業務級錯誤
| 錯誤代碼 | 詳細描述 |
|---|---|
| 1010 | xxxx |
MARKDOWN:
## 用戶信息接口列表
---
#### 讀取接口
| | |
|:-------------:|:-------------|
| [users/mobile](#users-mobile) | 獲取用戶手機號 |
#### 寫入接口
| | |
|:-------------:|:-------------|
| [users/mobile/put](#users-mobile-put) | 上傳用戶手機號 |
## 用戶信息接口詳情
* #### users/mobile
---
獲取用戶手機號
##### 是否需要權限驗證
---
是
##### 請求參數
---
| | 必選 | 類型 | 說明 |
|:-------------:|:-------------|:-------------|
| userId | true | int | 用戶ID |
##### 請求方法
---
GET
##### 調用樣例
---
` ``
users/mobile?userId=214
` ``
##### 返回結果
---
*** JSON示例 ***
` ``
{
"code": 0,
"msg": "",
"data": {
"mobile": 150888888888
}
}
` ``
*** 錯誤返回值 ***
| code | msg | 說明 |
|:-------------:|:-------------|
| 1010 | xxxx | xxxx |
關于其它錯誤返回值與錯誤代碼，參見 [錯誤代碼說明](#errorcode)
## ErrorCode
### 錯誤代碼對照表
---
##### 系統級錯誤
---
| 錯誤代碼 | 返回msg | 詳細描述 |
|:-------------:|:-------------|
| 400 | 系統錯誤，請稍候再試 | 請求參數有誤 |
| 401 | 系統錯誤，請稍候再試 | 用戶未登錄 |
| 404 | 系統錯誤，請稍候再試 | 資源未找到 |
| 405 | 系統錯誤，請稍候再試 | 請求方法不支持 |
| 500 | 系統錯誤，請稍候再試 | 服務器錯誤 |
##### 業務級錯誤
---
| 錯誤代碼 | 詳細描述 |
|:-------------:|:-------------|
| 1010 | xxxx |
