Swagger UI API文件生產工具基本介紹

2021-10-09 22:07:06 字數 2444 閱讀 9927

匯入依賴

>

>

io.springfoxgroupid

>

>

springfox-swagger-uiartifactid

>

>

2.9.2version

>

dependency

>

>

>

io.springfoxgroupid

>

>

springfox-swagger2artifactid

>

>

2.9.2version

>

dependency

>

配置

只要controller中介面的返回值中存在實體類,就會被掃瞄到swagger的model中

swagger對生成api文件的範圍有三種不同的選擇

@configuration

@enableswagger2

public

class

swaggerconfig

private apiinfo apiinfo()

}

實體類註解

@apimodel 註解用於實體類,表示對類進行說明,用於引數用實體類接收。

@apimodelproperty 註解用於類中屬性,表示對 model 屬性的說明或者資料操作更改。

@apimodel

(value =

"使用者實體類"

)public

class

user

controller相關註解

@api 註解用於類上,表示標識這個類是 swagger 的資源。

@apioperation 註解用於方法,表示乙個 http 請求的操作。

@apiparam 註解用於引數上,用來標明引數資訊。

@restcontroller

("/swagger"

)@api

(value =

)public

class

testcontroller")

@apioperation

(value =

"根據使用者唯一標識獲取使用者資訊"

)public jsonresult

getuserinfo

(@pathvariable

@apiparam

(value =

"使用者唯一標識"

) long id)

}

總結:

可以通過swagger給一些比較難理解的屬性或者介面增加注釋資訊

介面文件實時更新

在正式發布時,關閉swagger

swaggerproperties

@data

@equalsandhashcode

(callsuper =

false

)@builder

public

class

swaggerproperties

securityscheme : 這用於描述我們的api如何保護(基本認證,oauth2,…)

security context:定義乙個安全上下文

public

abstract

class

baseswaggerconfig

return docket;

}public apiinfo apiinfo

(swaggerproperties swaggerproperties)

private list

securityschemes()

private list

securitycontexts()

private securitycontext getcontextbypath

(string pathregex)

private list

defaultauth()

//自定義swagger配置

public

abstract swaggerproperties swaggerproperties()

;}

swaggerconfig

@configuration

@enableswagger2

public

class

swaggerconfig

extends

baseswaggerconfig

}

swagger2 生成介面文件步驟

匯入jar包 swagger2 io.springfox groupid springfox swagger2 artifactid dependency 防止進入swagger頁面報型別轉換錯誤,排除2.9 2中的引用,手動增加1.5 21版本 io.swagger groupid swagger...

匯出swagger2生成的文件

沒錯這個專案就是專門根據json解析生成文件的。二 修改配置 解壓專案,並且用idea開啟。啟動要生成文件的專案,前提這個專案整合了swagger2,瀏覽 http localhost 8080 swagger ui.html 輸入 http localhost 8080 v2 api docs 儲...

百曉生 滑鼠右鍵新建新增RTF文件

百曉生 滑鼠右鍵新建新增rtf文件 今天想將空間日誌作個本地備份,但是苦於找不到適合的文字工具,因為一般的文字編輯工具都不支援貼圖。雖然word就可以滿足我們的需求,但檔案格式不用doc而是rtf 而我以前清理登錄檔時把所有的無用檔案都刪除了,所有現在需要重新加入rtf文件。我們既可以享用word提...