今天被前端訓了一頓,慌得一逼,說你們寫的接口,返回值寫的是什么東西,只有公共的三個字段......
我們的API文檔是基于 swagger 組件寫的.如是有了下面的東東
示例:
1. 將現(xiàn)有接口 @ApiOperation 注解,response字段去掉.
該字段作用:聲明指定返回值對象
修改后:
2. 將返回對象進行泛型聲明
聲明后swagger(絲襪哥) 會反射生成對象字段描述
3. 使用 @ApiModelPropety 注解寫明字段含義
@ApiModelProperty("XXX")
示例:
對于單字段及5個字段以內,可以用此方式說明返回值
接口入?yún)⒙暶鳛閷ο蠼邮?/p>
對象字段用 @ApiParam 注解進行標注
單字段或多字段用 @ApiImplicitParams @ApiImplicitParam 進行標注
另外有需要云服務器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內外云服務器15元起步,三天無理由+7*72小時售后在線,公司持有idc許可證,提供“云服務器、裸金屬服務器、高防服務器、香港服務器、美國服務器、虛擬主機、免備案服務器”等云主機租用服務以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務可用性高、性價比高”等特點與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應用場景需求。