溫馨提示×

溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊×
其他方式登錄
點(diǎn)擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

swagger 返回值描述

發(fā)布時(shí)間：2020-03-27 09:09:45 來源：網(wǎng)絡(luò) 閱讀：16645 作者：liuhanling 欄目：軟件技術(shù)

今天被前端訓(xùn)了一頓,慌得一逼,說你們寫的接口,返回值寫的是什么東西,只有公共的三個(gè)字段......


我們的API文檔是基于 swagger 組件寫的.如是有了下面的東東


示例:

swagger 返回值描述


1.1.           返回字段

1.1.1.  返回字段(對象)

1.     將現(xiàn)有接口 @ApiOperation 注解,response字段去掉.

該字段作用:聲明指定返回值對象

swagger 返回值描述

 

修改后:

swagger 返回值描述

 

2.     將返回對象進(jìn)行泛型聲明

聲明后swagger(絲襪哥) 會(huì)反射生成對象字段描述

 swagger 返回值描述

3.     使用 @ApiModelPropety 注解寫明字段含義

@ApiModelProperty("XXX")

 

示例:


 swagger 返回值描述

1.1.2.  返回字段(單字段)

對于單字段及5個(gè)字段以內(nèi),可以用此方式說明返回值

 

swagger 返回值描述

 

 

1.2.      請求字段

1.2.1.  請求字段(對象)

接口入?yún)⒙暶鳛閷ο蠼邮?/span>


 swagger 返回值描述

對象字段用 @ApiParam 注解進(jìn)行標(biāo)注


 swagger 返回值描述

1.2.2.  請求字段(單字段或多字段)

單字段或多字段用 @ApiImplicitParams @ApiImplicitParam 進(jìn)行標(biāo)注

swagger 返回值描述

向AI問一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場，如果涉及侵權(quán)請聯(lián)系站長郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手