request2doc 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
request2doc 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
request2doc 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 PHP 查看源码 »
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 konglo
适用人群 未知
收录时间 2017-05-14

软件简介

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}

image

GUI

image

展开阅读全文

代码

评论

点击加入讨论🔥(1) 发布并加入讨论🔥
暂无内容
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
1 评论
8 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部