swagger 返回值描述

2021-10-25 20:21:46 字數 1165 閱讀 3376

今天被前端訓了一頓,慌得一逼,說你們寫的介面,返回值寫的是什麼東西,只有公共的三個欄位......

我們的api文件是基於 swagger 元件寫的.如是有了下面的東東

示例:

1.1.1.  返回字段(物件)

1.     將現有介面 @apioperation 註解,response欄位去掉.

該欄位作用:宣告指定返回值物件

修改後:

2.     將返回物件進行泛型宣告

宣告後swagger(**哥) 會反射生成物件字段描述

3.     使用 @apimodelpropety 註解寫明字段含義

@apimodelproperty

("***")

示例:

1.1.2.  返回字段(單字段)

對於單字段及5個字段以內,可以用此方式說明返回值

1.2.1.  請求字段(物件)

介面入參宣告為物件接收

物件欄位用 @apiparam 註解進行標註

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

單字段或多字段用 @apiimplicitparams @apiimplicitparam 進行標註

有返回值和無返回值函式

前面在定義函式時,有些函式使用了return語句,有些函式沒有使用return語句,使用return語句與不使用return語句有什麼區別呢?由前面的章節我們知道,若定義函式時沒有使用return語句,則預設返回乙個none。要返回乙個none,可以只寫乙個return,但要返回具體的數值,就需要在...

返回值優化

通過傳值方式返回要建立新物件時,應注意使用的形式,例如在operator return integer left.l right.l 咋看起來這像是乙個 對乙個建構函式的呼叫 其實並非如此。這是臨時物件語法,它是在說 建立乙個臨時integer物件並返回它 據此我們可能認為如果建立乙個有名字的區域性...

返回值優化

返回值優化,是一種屬於編譯器的技術,它通過轉換源 和物件的建立來加快源 的執行速度。rvo return value optimization。class complex 複數 complex const complex a real a.real imag a.imag complex opera...