swagger2 0公升級到3 0小結

2021-10-11 01:35:54 字數 2596 閱讀 2516

專案採用的spring boot 2.2.8 在此基礎上進行的整合。

另外使用

swagger 2.0 pom檔案:

-->

io.springfox<

/groupid>

springfox-swagger2<

/artifactid>

<

/dependency>

io.springfox<

/groupid>

springfox-swagger-ui<

/artifactid>

<

/dependency>

swagger3.0pom檔案:

io.swagger.core.v3<

/groupid>

swagger-core<

/artifactid>

2.0.8

<

/version>

<

/dependency>

io.swagger.core.v3<

/groupid>

swagger-annotations<

/artifactid>

2.0.8

<

/version>

<

/dependency>

需要注意的是:

io.springfox<

/groupid>

springfox-boot-starter<

/artifactid>

<

/dependency>

使用這個swagger的註解等基本和2.0無異。

swagger2.0配置檔案:

@configuration

// 2.0註解配置

@enableswagger2

public

class

swagger2config

private apiinfo apiinfo()

}

swagger3.0配置檔案:

@configuration

// 3.0使用此註解

@enableopenapi

public

class

swagger2config

private apiinfo apiinfo()

}

作用域

2.0版本註解

3.0版本註解

類物件@ apimodel

@schema

屬性@apimodelproperty

@schema

屬性@apimodelproperty

@arrayschema

類@api

@tag

方法@apioperation

@operation

方法@apiresponses

@apiresponses

方法@apiresponse

@apiresponse

swagger 2.0:

@data

@apimodel

(value =

"首頁頭部資訊"

,description =

"首頁頭部資訊"

)public

class

indexheadinfovo

implements

serializable

swagger 3.0:

@data

@schema

(name =

"首頁頭部資訊"

, description =

"首頁頭部資訊"

)public

class

indexheadinfovo

implements

serializable

@tag

(name =

"test-controller"

,description =

"相關控制器"

)public

class

testcontroller

}

問題1:為什麼在實體物件的屬性中要使用example欄位?

主要是為了在文件上讓對接人看起來方便。如果屬性中使用description,只會在schema裡面展示。

@schema裡面的具體定義:type代表修飾字段的型別,一般分為string,boolean,object,date,integer等。

問題2:為什麼tag相當於api?

tag可以自定義,具體釋義可以看原始碼的文件備註非常清楚,這裡主要還是方便對接人看。如下圖:

用tag的方式可以比較直觀。

mongodb 從3 0 公升級到3 2

curl k v o mongodb linux x86 64 debian71 3.2.7.tgz 解壓mongodb tar xvzf mongodb linux x86 64 rhel62 3.2.7.tgz 關閉mongod 參考 url 備份舊的bin sudo mv bin bin ba...

mysql公升級 5 1公升級到5 7

一 mysql公升級 1.備份資料庫 mysqldump u root ppasswod all databases data bak db bak date y m d h m sql 同時可備份整個mysql目錄,包括data目錄,可用於公升級失敗快速回滾 2.安裝5.7 提供兩種安裝方式參考,...

從WSS 2 0公升級到WSS 3 0(安裝篇)

好幾天都在折磨公升級的事情,有可能是資料庫的內容太多了,或者是資料庫的內容太亂了,公升級了好幾次都沒有成功,因此這篇文章都沒有繼續寫。安裝篇其實沒有什麼東西可以說,就是簡單的截圖 今天感冒了,先不截屏,各位先將就一下 第一步,提示一下安裝什麼東西 第二步,安裝開始,或者自行選擇安裝的型別,這裡要注意...