您好,登錄后才能下訂單哦!
今天被前端訓了一頓,慌得一逼,說你們寫的接口,返回值寫的是什么東西,只有公共的三個字段......
我們的API文檔是基于 swagger 組件寫的.如是有了下面的東東
示例:
1. 將現有接口 @ApiOperation 注解,response字段去掉.
該字段作用:聲明指定返回值對象
修改后:
2. 將返回對象進行泛型聲明
聲明后swagger(絲襪哥) 會反射生成對象字段描述
3. 使用 @ApiModelPropety 注解寫明字段含義
@ApiModelProperty("XXX")
示例:
對于單字段及5個字段以內,可以用此方式說明返回值
接口入參聲明為對象接收
對象字段用 @ApiParam 注解進行標注
單字段或多字段用 @ApiImplicitParams @ApiImplicitParam 進行標注
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。