Swagger筆記 Swagger3配置

2022-09-14 13:57:13 字數 3009 閱讀 8253

swagger是一組圍繞openapi規範構建的開源工具，可幫助您設計、構建、記錄和使用rest api。主要的swagger工具包括：

swagger editor– 基於瀏覽器的編輯器，您可以在其中編寫openapi規範。

swagger ui– 將openapi規範呈現為互動式api文件。

swagger2於17年停止維護，現在最新的版本為swagger3（open api3）。

springfox引入方式

io.springfox


springfox-boot-starter


3.0.0
knife4j引入方式

com.github.xiaoymin


knife4j-spring-boot-starter


3.0.3
引入美化bootstrap-ui

com.github.xiaoymin


swagger-bootstrap-ui


1.8.5


import com.github.xiaoymin.swaggerbootstrapui.annotations.enableswaggerbootstrapui;


import io.swagger.annotations.apioperation;


import org.springframework.context.annotation.bean;


import org.springframework.context.annotation.configuration;


import org.springframework.context.annotation.profile;


import springfox.documentation.builders.apiinfobuilder;


import springfox.documentation.builders.pathselectors;


import springfox.documentation.builders.requesthandlerselectors;


import springfox.documentation.oas.annotations.enableopenapi;


import springfox.documentation.service.*;


import springfox.documentation.spi.documentationtype;


import springfox.documentation.spi.service.contexts.securitycontext;


import springfox.documentation.spring.web.plugins.docket;


import j**a.util.arraylist;


import j**a.util.hashset;


import j**a.util.list;


import j**a.util.set;


/** * @author rongrong


* @version 1.0


* @description swagger3配置


* @date 2021/01/12 21:00


*/@configuration


@profile()


@enableopenapi


@enableswaggerbootstrapui


public class swaggerconfig ")*/


private boolean enable;


/*** 建立api


* http:ip:埠號/swagger-ui/index.html 原生位址


* http:ip:埠號/doc.html bootstrap-ui位址


*/@bean


public docket createrestapi() 


/*** 支援的通訊協議集合


** @param type1


* @param type2


* @return


*/private setnewhashset(string type1, string type2) 


/*** 認證的安全上下文


*/private listsecurityschemes() 


/*** 授權資訊全域性應用


*/private listsecuritycontexts() 


private listdefaultauth() 


/*** 新增摘要資訊


* @return 返回apiinfo物件


*/private apiinfo apiinfo() 


}
http:ip:埠號/swagger-ui/index.html 原生位址


http:ip:埠號/doc.html bootstrap-ui位址


不建議使用swagger原生頁面設定許可權，建議使用doc頁面設定token，搜尋介面更方便(主要是好看)


在這裡插入描述


Swagger學習筆記（2020 11 17）
1.建立乙個spring boot web專案 2.匯入相關依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 3.編寫helloword 4.配置swagger config config...


swagger使用 筆記
引入依賴 io.springfoxgroupid springfox swagger uiartifactid 2.9.2version dependency io.springfoxgroupid springfox swagger2artifactid 2.9.2version dependen...


SpringBoot專案整合Swagger2
swagger 是最流行的 api 開發工具，它遵循 openapi specification openapi 規範，也簡稱 oas swagger 可以貫穿於整個 api 生態，如 api 的設計 編寫 api 文件 測試和部署。swagger 是一種通用的，和程式語言無關的 api 描述規範。...