生成 API 说明文档 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}
如图:
界面预览
一、推荐使用迅雷或快车等多线程下载软件下载本站资源。
二、未登录会员无法下载,登录后可获得更多便利功能,若未注册,请先注册。
三、如果服务器暂不能下载请稍后重试!总是不能下载,请点我报错 ,谢谢合作!
四、本站大部分资源是网上搜集或私下交流学习之用,任何涉及商业盈利目的均不得使用,否则产生的一切后果将由您自己承担!本站将不对任何资源负法律责任.如果您发现本站有部分资源侵害了您的权益,请速与我们联系,我们将尽快处理.
五、如有其他问题,请加网站设计交流群(点击这里查看交流群 )进行交流。
六、如需转载本站资源,请注明转载来自并附带链接
七、本站部分资源为加密压缩文件,统一解压密码为:www.aizhanzhe.com
大家评论
站长推荐
点击排行
- 1Foxit Reader Pro V8.0.1.0628 中文去广告优化版 小巧PDF文档阅读软件
- 2calibre-64bit-3.41.3_EPUB电子书阅读器
- 3JetbrainsCrack-4.2-release-enc.jar 激活补丁包 最新版(附激活方法+注册码)[3.83MB]
- 4IntelliJ IDEA 2019.3.3 旗舰版 官方正式版(附汉化包+激活码+汉化激活方法)[1.32GB]
- 532个经典Access模板
- 6基于高德地图的位置选择插件 Bootstrap-AMapPositionPicker
- 7IntelliJ IDEA 2019.3.3 社区版 官方正式版(附汉化包+汉化激活方法+破解补丁)[1.69GB]
- 8IntelliJ IDEA 2019.3 增强版 中文绿色旗舰版(附汉化包+激活补丁+破解方法)[791.46MB]
- 9jQuery Pivot 表格插件 PivotTable.js
- 10sql server 2005 64位 win7 精简标准版 for32&64位