通过脚本生成文档,希望支持空格符号以及引号

[guanxiaoguan]

/**

• showdoc
• @remark curl -H "Content-Type: application/json" -X POST 127.0.0.1:8000/test/josn --data '{"name":"111","flag":true}' */

这样可以快速拷贝curl 指令,方便测试.

[guanxiaoguan]

* @method post
* @url 127.0.0.1:8000/test/josn
* @json_param {"name":"111","flag":true}

或者根据这几个直接生成curl 测试指令

[star7th]

很难做到。程序都是根据空格来切割内容的。你再含有空格的话，会引起歧义和混乱

[guanxiaoguan]

那么根据注释中的 mehtod ,url , json_param,header 呢 ? 没有空格, 拼一行 curl 指令

[star7th]

没明白你在说什么，没有空格, 拼一行 curl 指令是什么意思

[guanxiaoguan]

 /**
* showdoc
* @catalog 接口说明
* @title 测试接口
* @description 测试接口
* @method post
* @header Content-Type:application/json 必选 string Header信息 
* @url http://ip:port/test
* @json_param {"name":"xxx","age":20}
* @param name  必选  std::string  姓名
* @param age   必选   int  年龄
* @return {"state":0}
* @return_param state   int   接口状态码，0成功
*/

根据接口注释,生成的文档中,添加一行文本:
curl -H "Content-Type: application/json" -X POST http://ip:port/test --data '{"name":"xxx","age":20}'

方便用户直接在接口文档中拷贝这行文本.在linux终端上方便接口测试.

[star7th]

你这个想法是好的，但是可能不够通用。大部分情况下，文档的阅读者是app或者前端开发人员，你让他们用curl测试，用处不大。我比较建议你生成runapi文档，要测试也是在runapi上测试，容易一些。

[guanxiaoguan]

是的,但文档的阅读者不止前端开发哦,后端的同学也很多的. 比如我,写好的程序放到某个云服务器上,远程连接centos或者ubuntu都是无界面的,可能还需要vpn登录,要测试程序的接口,只能远程登录用curl 执行.

目前我的做法,是在showdoc上创建了一个单独的页面,提前手动敲好curl命令, 用的时候拷贝一下.

[star7th]

接口测试请使用runapi ， shell脚本支持生成runapi类型文档。