用swagger2 ，维护API文档很麻烦吗？返回值无法说明？ --- 还是没用对方法？

本文主要是介绍用swagger2 ，维护API文档很麻烦吗？返回值无法说明？ --- 还是没用对方法？，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

之前在和一些技术同事聊到了接口文档这事，并提到了swagger，收到的反馈有这些：

“很麻烦！接口文档要和代码耦合在一起”

“字段说明要写好几遍！一改要改好多地方！”

"请求参数想描述清楚要写一堆玩意儿！！"

 

我也看了下，控制器方法上要对每个参数这么描述，确实有点反人类啊！

@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
})

并且对于返回值，往往大多的示例都是封装了一个响应对象，类似：

@Data
public class RespData{public static final int Success = 1;public static final int Error = 0;private int status;private Object da

这篇关于用swagger2 ，维护API文档很麻烦吗？返回值无法说明？ --- 还是没用对方法？的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---