request2doc生成 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}
GUI
评论
apidocWeb API 文档生成
生成一个REST风格的WebAPI文档。支持的编程语言:C#,Go,Dart,Java,JavaScript,PHP(allDocStylecapablelanguages)CoffeeScriptE
apidocWeb API 文档生成
0
Api说明
通用请求域名https://uni.apistd.com公共参数公共参数为调用 API 请求时必须携带的参数,统一使用 URL Query 参数传输。参数名类型是否必填描述示例值actionstring是接口名sms.message.sendaccessKeyIdstring是请求 AccessKe
合一云
0
API-docRESTful API 文档生成工具
RESTfulAPI标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。1.遵循OpenAPI规范编写RESTfulAPI的接口定义2.生成直观的HTML和PDF格式的
API-docRESTful API 文档生成工具
0
API-docRESTful API 文档生成工具
RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发
API-docRESTful API 文档生成工具
0
APIdoc-GoRESTful API 文档生成工具
APIdoc是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生
APIdoc-GoRESTful API 文档生成工具
0
APIdoc-GoRESTful API 文档生成工具
APIdoc是一个简单的RESTfulAPI文档生成工具,它从代码注释中提取特定格式的内容,生成文档。目前支持支持以下语言:C#、C/C++、Go、Java、Javascript、Perl、PHP、P
APIdoc-GoRESTful API 文档生成工具
0
ZetaAPI动态生成 Api 文档
ZetaAPI是一个使用SQL+XML快速创建Api接口与使用文档的框架,帮助开发者提升开发效率。框架特性配置简单功能丰富使用xml标签属性就可支持缓存,默认缓存实现为caffeine,也可自定义缓存
ZetaAPI动态生成 Api 文档
0
YUI DocJavaScript API文档生成工具
YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成
YUI DocJavaScript API文档生成工具
0