今天被前端訓了一頓,慌得一逼,說你們寫的接口,返回值寫的是什麼東西,只有公共的三個字段......
我們的API文檔是基於 swagger 組件寫的.如是有了下面的東東
示例:
1.1. 返回字段
1.1.1. 返回字段(對象)
1. 將現有接口 @ApiOperation 註解,response字段去掉.
該字段作用:聲明指定返回值對象
修改後:
2. 將返回對象進行泛型聲明
聲明後swagger(絲襪哥) 會反射生成對象字段描述
3. 使用 @ApiModelPropety 註解寫明字段含義
@ApiModelProperty("XXX")
示例:
1.1.2. 返回字段(單字段)
對於單字段及5個字段以內,可以用此方式說明返回值
1.2. 請求字段
1.2.1. 請求字段(對象)
接口入參聲明爲對象接收
對象字段用 @ApiParam 註解進行標註
1.2.2. 請求字段(單字段或多字段)
單字段或多字段用 @ApiImplicitParams @ApiImplicitParam 進行標註
