用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
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值