Api文件的編輯

在用markdown編輯api文件的時候，可以自動生成目錄。用git做版本管理，然後用工具Typora（可以直接到typora官網下載）來檢視

  1 [TOC]  
  2 # XXX專案api文件
  3 ## 介面說明：
  4 ### 一. 組織管理
  5 #### 1. 組織架構相關
  6 ##### 1.1 組織架構人員同步
  7 >獲取政務微信組織架構
  8 >請求引數：
  9 
 10 | 引數名       | 說明           | 引數型別    | 是否必須 | 預設值|
 11 | ------------| ---------------| -----------| --------| ---- |
 12
 
 | token         | token |  string |是  |     | 
 13 
 14 請求例項：
 15    GET/POST
 16    [v1/test/sync]()
 17    HTTP/1.1 Host: [https://test.XXX.com/api/]
 18 
 19 返回結果：
 20 ```json
 21 {
 22     "code": 0,
 23     "data": [],
 24     "msg": "已傳送到同步佇列，請稍後檢視結果"
 25 }
 26 ```
 27 
 28 返回引數：
 29 
 30 
 31 | 引數名       | 含義                  | 引數型別   | 長度 |
 32
 
 | ------------ | ---------------------| ---------- | ---- |
 33 |msg           |提示資訊              | string    |  -   |
 34 
 35 ##### 1.2 組織架構人員列表
 36 
 37 介面說明：
 38 >人員列表
 39 >請求引數：
 40 
 41 | 引數名       | 說明           | 引數型別    | 是否必須 | 預設值|
 42 | ------------| ---------------| -----------| --------| ---- |
 43
 
 | token         | token| string  | 是  |     |
 44 | limit         | 每頁條數| integer  | 是  |     |
 45 | page         | 頁碼| integer  | 是  |     |
 46 | position      | 職位| string  | 否  |   無  |
 47 
 48 請求例項：
 49    GET/POST
 50    [v1/test/user_list]()
 51    HTTP/1.1 Host: [https://test.XXX.com/api/]
 52 
 53 返回結果：
 54 獲取列表成功
 55 
 56 ```json
 57 {
 58     "code": 0,
 59     "data": {
 60         "current_page": 1,
 61         "total_page": 1,
 62         "total_count": 1
 63     },
 64     "msg": "獲取成功！"
 65 }
 66 ```
 67 返回引數：
 68 
 69 | 引數名      | 含義                | 引數型別   | 長度 |
 70 | ----------- | --------------------| ------ | ---- |
 71 |cusTags      | 標籤   | array  | -   |
 72 |current_page      | 當前頁|  integer  |
 73 |total_page      | 總頁數|  integer  |
 74 |total_count      | 總條數|  integer  |
 75 
 76 
 77 
 78 #### 2. 工作小組
 79 ##### 2.1匯入工作小組
 80 
 81 >匯入工作小組
 82 >請求引數：
 83 
 84 | 引數名       | 說明           | 引數型別    | 是否必須 | 預設值|
 85 | ------------| ---------------| -----------| --------| ---- |
 86 | token         | token |  string |是  |   是  | 
 87 | activityid      | 活動id   | string  | 是   |
 88 
 89 請求例項：
 90    GET/POST
 91    [v1/test/import_work_group]()
 92    HTTP/1.1 Host: [https://test.XXX.com/api/]
 93 
 94 返回結果：
 95 ```json
 96 {
 97     "code": 0,
 98     "data": [],
 99     "msg": "匯入成功"
100 }
101 ```
102 
103 返回引數：
104 
105 
106 | 引數名       | 含義                  | 引數型別   | 長度 |
107 | ------------ | ---------------------| ---------- | ---- |
108 |msg           |提示資訊              | string    |  -   |
109 
110 
111 
112 ### 二.  通知訊息
113 #### 1. 巡檢任務通知訊息
114 >巡檢任務通知訊息
115 >請求引數：
116 
117 | 引數名       | 說明           | 引數型別    | 是否必須 | 預設值|
118 | ------------| ---------------| -----------| --------| ---- |
119 | token       | header中的token |  string |是  |   無  | 
120 | activityid  | header中的activityid  |  string |是  |   無  | 
121 
122 請求例項：
123    GET/POST
124    [v1/test/inspection]()
125    HTTP/1.1 Host: [https://test.XXX.com/api/]
126 
127 返回結果：
128 通知訊息傳送成功
129 ```json
130 {
131     "code": 0,
132     "data": [],
133     "msg": ""
134 }
135 ```

說明：上面的[TOC] 代表會自動生成目錄

在typora上面檢視：