@BodyParam
请求体参数设置,用法:@BodyParam 字段类型 字段名称 字段的相关描述。该设置仅在Post、Put、Patch等方法下生效。
可以设置多条参数,最终在发送ajax请求时全部参数将放进请求体内。
字段类型 用{}里面包裹对应的类型来描述,一般为{String}、{String[]}、{Number}、{Number[]}、{Integer}、{Integer[]}、{Float}、{Float[]}、{Boolean}、{Array}、{Object}、{Object[]}、{File}、{Date}、{Date[]}、{Datetime}、{Datetime[]}等。
File类型只有在设置@ContentType multipart/form-data时才有效。
字段名称 用来指示在ajax请求时的查询字段,比如: pageSize。当字段名称用[]包裹时,表示该字段为可选传;无任何包裹时,表示该字段为必传。
示例:
/**
* @Api post /api/info/addNew
* ...
* @BodyParam {String} name 姓名字段
* @BodyParam {Number} [age] 年龄字段(可选)
* ...
*/