swagger介面文件的使用

2021-10-07 08:06:35 字數 1071 閱讀 4317

1.訪問位址為專案路徑+swagger-ui.html

2.swagger的配置使用

配置swagger的docket和apiinfo

@configuration

@enableswagger2 #配置swagger

public

class

swaggerconfiguration

") #配置檔案裡面設定為true 表示開啟swagger

private boolean enableswagger;

@bean

public docket config()

#文件的頭資訊

2. 在需要新增的介面上面新增相應的註解

@api(value=「xx跟蹤controller」,tags=) value - 字段說明 tags- 注釋說明這個類

@apioperation(value = 「testswagger-value」, notes = 「這個是swagger的描述」, response = string.class)

value 介面文件的值顯示在頁面上 notes 介面文件的描述 response相應型別

@apiimplicitparams請求引數集合

@apiimplicitparam請求的引數

name 請求的名字 value 請求的描述 required 引數必須傳 datatype 引數型別

Swagger介面文件

api 用在類上,說明該類的作用。apioperation 註解來給api增加方法說明。apiimplicitparams 用在方法上包含一組引數說明。apiimplicitparam 用來註解來給方法入參增加說明。apiresponses 用於表示一組響應 apiresponse 用在 apire...

使用swagger編寫開發介面文件

1.在pom.xml中匯入依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 2.在controller類中加註解 1.在類名上新增註解 api tags 生成驗證碼 enableswagg...

Swagger文件使用

有很多人不清楚swagger ui的路徑,由於我們使用了更為好用的swagger bootstrap ui,實際上使 網域名稱 埠 doc.html,如 http localhost 8080 doc.html 在沒有swagger之前,我們需要自己手寫文件,手寫文件的出現問題 文件更新時需要要與前...