swagger:配列/集合パラメータの正しい配置方式allowMultiple,dataType
3612 ワード
インタフェースパラメータの注記構成
主なパラメータ:
カスタムタイプの注記設定
特別:要素タイプが、 要素タイプがカスタムタイプ、例えば:
// 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 {
//...
}
特別:
int
、String
のようなオリジナルタイプの場合、このステップは必要ありません.UserDto
の場合、swaggerがこの要素に対応するタイプを見つけることができるように、このステップが必要です.