swagger: 数组/集合参数的正确配置方式allowMultiple、dataType

接口参数的注解配置

// GET参数
@ApiImplicitParam(name = "list", value = "用户ID列表", paramType = "query", allowMultiple = true, dataType = "int")

// POST参数
@ApiImplicitParam(name = "list", value = "用户名称列表", paramType = "body", allowMultiple = true, dataType = "String")

// POST参数-自定义类型User
@ApiImplicitParam(name = "list", value = "用户列表", paramType = "body", allowMultiple = true, dataType = "UserDto")

主要参数:

  • allowMultiple:允许多个,即:数组或集合。
  • dataType:数组或集合的元素类型,即:类名。

自定义类型的注解配置

@ApiModel(value = "UserDto", description = "用户")
public class User implements Serializable {
  //...
}

特别的:

  • 如果元素类型为原生类型,如:intString之类的,无需此步骤。
  • 如果元素类型为自定义类型,如:UserDto,则必须此步骤,以便swagger能够找到这个元素对应的类型。

你可能感兴趣的:(swagger: 数组/集合参数的正确配置方式allowMultiple、dataType)