Swagger定义API返回Map处理姿势

一般都是定义的对象作为出入参。只是对接别人接口发现,是动态参数,比如返回字段是xx01、xx02这种,可能会有N个字段。于是只能返回Map,但同时又想让Swagger给出基本的出参定义比如xx01系列的说明。

1. 定了一个类A extends ModelAndView,放入一批字段和动态字段的第一个,然后继承ModelAndView,之后把,继承出来的字段屏蔽掉,加上如下代码:

@ApiModelProperty(hidden = true)
@Override
public Map<String, Object> getModel() {
    return super.getModel();
}
@ApiModelProperty(hidden = true)
@Override
public boolean isEmpty() {
    return super.isEmpty();
}

@ApiModelProperty(hidden = true)
@Override
public ModelMap getModelMap() {
    return super.getModelMap();
}
@ApiModelProperty(hidden = true)
@Override
public boolean isReference() {
    return super.isReference();
}
@ApiModelProperty(hidden = true)
@Override
public HttpStatus getStatus() {
    return super.getStatus();
}
@ApiModelProperty(hidden = true)
@Override
public View getView() {
    return super.getView();
}
@ApiModelProperty(hidden = true)
@Override
public String getViewName() {
    return super.getViewName();
}

2.Controller中定义两个函数c1、c2,其中一个返回的就是c1返回的就是A,不过里面直接转发return new A("转发到c2"). c2方法返回Map,里面写具体内容即可。给c2加上

@ApiOperation(hidden = true)隐藏掉即可

这样既可以swagger文档既可以输出静态参数,同时调用又可以返回动态参数内容

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值