restapi文档生成器工具
restapidoc的Python项目详细描述
restful api文档生成脚本
=======
script，用带注释的php代码生成restful api文档。[输出示例可在此处找到]（http://htmlpreview.github.io/？https://raw.github.com/dzibas/rest-api-doc/master/documentation.html）
/**
*@route/v1/modulename/authentication
*@method POST
*@ingroup-modulename
*
*authentication-service-example
*
*HTTP响应代码显示登录状态：
*
*-202：请求被接受
*-401：无效的用户名/密码
*-403：请求被拒绝
*-503：服务不可用
*
*@示例输入
*
**POST/v1/modulename/authentication HTTP/1.1
*内容类型：application/json；charset=utf-8
*
*{
*“username”：“demousername”，
*“passwrod”：“demopassword”，
*}
*
*@示例输出
*
*{
*“消息”：“请求已接受”，
*“id”：386
*}
*
*@jsonparam username extranet username required
*@jsonparam password extranet password required
*@returns json
*/
Installation
==
pip install-r requirements.txt
=
=$python parse.py-c
==
用法：PARSE.[-H] [-C[[-DIr] [[-OFF] ] [BR/>
可选参数：
-H，帮助显示此帮助消息，并退出
-C，覆盖到STDIN文档覆盖范围
-DIR，--dir dir文件夹，我们需要在其中查找文档
注释默认值：test_src_folder/
--筛选要在其中搜索的文件的筛选器gob filter默认值：
*controler*.php
-o输出，--output输出文件名。默认值：documentation.html
open generated documentation.html
=======
script，用带注释的php代码生成restful api文档。[输出示例可在此处找到]（http://htmlpreview.github.io/？https://raw.github.com/dzibas/rest-api-doc/master/documentation.html）
/**
*@route/v1/modulename/authentication
*@method POST
*@ingroup-modulename
*
*authentication-service-example
*
*HTTP响应代码显示登录状态：
*
*-202：请求被接受
*-401：无效的用户名/密码
*-403：请求被拒绝
*-503：服务不可用
*
*@示例输入
*
**POST/v1/modulename/authentication HTTP/1.1
*内容类型：application/json；charset=utf-8
*
*{
*“username”：“demousername”，
*“passwrod”：“demopassword”，
*}
*
*@示例输出
*
*{
*“消息”：“请求已接受”，
*“id”：386
*}
*
*@jsonparam username extranet username required
*@jsonparam password extranet password required
*@returns json
*/
Installation
==
pip install-r requirements.txt
=
=$python parse.py-c
==
用法：PARSE.[-H] [-C[[-DIr] [[-OFF] ] [BR/>
可选参数：
-H，帮助显示此帮助消息，并退出
-C，覆盖到STDIN文档覆盖范围
-DIR，--dir dir文件夹，我们需要在其中查找文档
注释默认值：test_src_folder/
--筛选要在其中搜索的文件的筛选器gob filter默认值：
*controler*.php
-o输出，--output输出文件名。默认值：documentation.html
open generated documentation.html
欢迎加入QQ群-->： 979659372
