request2doc RequireUsageExampleOutputGUI 介绍
request2doc
自动根据发送的请求生成 API 说明文档。文档模板可定制,默认为 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数据键值对, e.g. key1=value&key2=value -t [TEMPLATE], --template [TEMPLATE] 模板文件路径,默认为markup.tpl -o [OUTPUT], --output [OUTPUT] 将文件输出到指定文件,默认为打印到屏幕 -s [SLICE_STARTSWITH], --slice-startswith [SLICE_STARTSWITH] 只打印返回数据中指定域的数据, 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参数: ||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
request2doc RequireUsageExampleOutputGUI 官网
https://github.com/kongxinchi/request2doc
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。