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 = "header", name = "Authentication", dataType = "String", required = true, value = "用户token")
    })
    @PostMapping("/users/user")
    public CommonResult<UserCreateResponse> 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