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

java—自动api文档生成Yapi

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

word文档缺点：

• 手动编写，出错性很高
• 文档可读性差，考验编写者的耐心
• 无法在线调试
• 及时性差

swwager文档缺点：

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

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

@ApiOperation("管理员创建用户")
@ApiImplicitParams({
        @ApiImplicitParam(paramType = "header", name = "Authentication", dataType = "String", required = true, value = "用户token")
})
@PostMapping("/users/user")
public CommonResult createUser(@Validated @RequestBody UserAddRequest userAddRequest) {
    Assert.isTrue(userAddRequest != null, "invalid userAddRequest");
    return CommonResult.ok(userService.addUser(userAddRequest));
}

Yapi使用，官方教程：https://hellosean1025.github.io/yapi/documents/index.html
————————————————
版权声明：本文为CSDN博主「jiangxuanzi1993」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/u014469254/article/details/109362854