注解:
@ApiImplicitParams
@ApiImplicitParam
name="需注解的API輸入參數",
value="接收參數的意義描述",
paramType="參數存放位置",
dataType="參數類型,可傳基本類型、類、泛型類等",
required="輸入參數是否必傳"
其它屬性暫時忽略,具體可查看官網等資源。
敲重點:屬性“dataType”基本類型、類按照正常來賦值,自定義泛型類應該按照如下格式來賦值:
例如:dataType = "demo«ArrayList«demo1»»",重點是符號“«»”。
以下摘自swagger2源碼(各位看官請自行體會):
fieldName |
typeName |
qualifiedTypeName |
genericByteArray |
GenericType«Array«byte»» |
springfox.documentation.schema.GenericType<byte[]> |
genericCategoryArray |
GenericType«Array«Category»» |
springfox.documentation.schema.GenericType<springfox.documentation.schema.Category[]> |
示例:
@ApiImplicitParams(value = {@ApiImplicitParam(name = "input", value = "接收參數的意義描述", paramType = "body", dataType = "demo«ArrayList«demo1»»", required = true), @ApiImplicitParam(name = "index", value = "接收參數的意義描述", paramType = "query", dataType = "String", required = true)})
效果圖: