java---自动api文档生成Yapi

java---自动api文档生成Yapi


开发过程中,接口文档是前后端,测试交互的依据,文档更新的及时性和准确性很重要。

word文档缺点:

  1. 手动编写,出错性很高
  2. 文档可读性差,考验编写者的耐心
  3. 无法在线调试
  4. 及时性差

swwager文档缺点:

  1. 文档可读性差
  2. 针对需要带授权token的请求,无法在线调试
  3. 无法导入和导出api文档
  4. 测试和开发无法在文档上沟通

Yapi解决以上所有问题,yapi可以支持java apidoc ,兼容swwager,只需要idea安装对应插件,就可以实现右键点击upload to yapi,自动生成api接口文档

    @ApiOperation("管理员创建用户")
    @ApiImplicitParams({
   
            @ApiImplicitParam(paramType 
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值