request2doc生成 API 說明文檔

request2doc

自動(dòng)根據(jù)發(fā)送的請(qǐng)求生成 API 說明文檔。文檔模板可定制，默認(rèn)為 wiki markup 格式。

Require

pip install jinja2

wxpython: https://www.wxpython.org/download.php

Usage

usage: request2doc.py [-h] [-d [DATA]] [-t [TEMPLATE]] [-o [OUTPUT]]
                  [-s [SLICE_STARTSWITH]] [-b [COOKIE_JAR]]
                  [url]

positional arguments:
  url                   URL

optional arguments:
  -h, --help                                                     show this help message and exit
  -d [DATA], --data [DATA]                                       POST數(shù)據(jù)鍵值對(duì), e.g. key1=value&key2=value
  -t [TEMPLATE], --template [TEMPLATE]                           模板文件路徑，默認(rèn)為markup.tpl
  -o [OUTPUT], --output [OUTPUT]                                 將文件輸出到指定文件，默認(rèn)為打印到屏幕
  -s [SLICE_STARTSWITH], --slice-startswith [SLICE_STARTSWITH]   只打印返回?cái)?shù)據(jù)中指定域的數(shù)據(jù), e.g. data.results
  -b [COOKIE_JAR], --cookie-jar [COOKIE_JAR]                     cookie-jar文件路徑

Example

python request2doc.py http://any/get/url?key1=value1&key2=value2
python request2doc.py -d "key1=value1&key2=value2" http://any/post/url

Output

h3.teacher/homework/search
METHOD: GET
----
GET參數(shù):
||Name||Type||Description||
| status | Int |  |
返回字段說明:
||Name||Type||Description||
| a.\* |  | 0\|1 |
| a.\*.a | Float\|Int |  |
| a.\*.b | Int\|String |  |

{code:title=返回JSON樣例|collapse=true}
{
  "data": {
    "a": [
      {
        "a": 1, 
        "b": 2
      }, 
      {
        "a": 1.1, 
        "b": "string"
      }
    ]
  }, 
  "message": "", 
  "error_code": 0, 
  "success": true
}
{code}

GUI