Web API文档生成工具apidoc

详情请看转载http://www.jianshu.com/p/bb5a4f5e588a

详细文档 http://blog.csdn.net/lvbaolin123/article/details/52671677

window下安装http://www.bubuko.com/infodetail-948579.html

第一步,在要生成的项目下创建 apidoc.json、

{
  "name" : "APP接口",
  "version": "1.0.0",
  "title": "APP接口", 
  "description": ""
}

第二步,结合文档编写注释,

第三步.在要生成的项目下,按住左Shift,点击鼠标右键,选择“在此处打开命令窗口” 输入命令 

apidoc -i src -o ./doc


遇到的问题

1、apiGroup用中文


在你的每个分组下的API中添加以下注释(java):
/**
* @apiDefine UserGroup
*
* 用户组
*/
那么在导航的测边栏apiGroup名就是中文的了 


2、测试总是返回 error:0


这个是 跨域导致的 你可以添加一行代码
java下的
```
response.addHeader("Access-Control-Allow-Origin", "*");
response.addHeader("Access-Control-Allow-Methods", "get, post, put, delete, options");
response.addHeader("Access-Control-Allow-Headers", "origin, content-type, accept");
response.addHeader("Access-Control-Allow-Credentials", "true");
```     

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值