關(guān)于springboot集成swagger及knife4j的增強(qiáng)問(wèn)題
參考鏈接:狂神的Swagger筆記
- 號(hào)稱(chēng)世界上最流行的API框架
- Restful Api 文檔在線自動(dòng)生成器 => API 文檔 與API 定義同步更新
- 直接運(yùn)行,在線測(cè)試API
- 支持多種語(yǔ)言 (如:Java,PHP等)
- 官網(wǎng):swagger
SpringBoot集成Swagger 添加maven依賴(lài)
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
要求:jdk 1.8 + 否則swagger2無(wú)法運(yùn)行 要使用Swagger,我們需要編寫(xiě)一個(gè)配置類(lèi)-SwaggerConfig來(lái)配置 Swagger
package com.yf.exam.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; @Configuration @EnableSwagger2 public class SwaggerConfig { //配置了swagger的Docket 的 bean 實(shí)例 @Bean public Docket docket(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()); } //配置 swagger 信息 = apiInfo private ApiInfo apiInfo(){ //作者信息 Contact contact = new Contact("瀟七", "https://www.xhost.vip/", "2278023068@qq.com"); return new ApiInfo("API文檔", "接口信息", "v1.0", contact, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList() ); } }
訪問(wèn)測(cè)試 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;
-
knife4j
官網(wǎng)參考地址:knife4j
knife4j是為Java MVC框架集成Swagger生成Api文檔的增強(qiáng)解決方案(在非Java項(xiàng)目中也提供了前端UI的增強(qiáng)解決方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一樣小巧,輕量,并且功能強(qiáng)悍!
簡(jiǎn)潔
基于左右菜單式的布局方式,是更符合國(guó)人的操作習(xí)慣吧.文檔更清晰…
個(gè)性化配置
個(gè)性化配置項(xiàng),支持接口地址、接口description屬性、UI增強(qiáng)等個(gè)性化配置功能…
增強(qiáng)
接口排序、Swagger資源保護(hù)、導(dǎo)出Markdown、參數(shù)緩存眾多強(qiáng)大功能.
SpringBoot集成Knife4j 添加maven依賴(lài)
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <!--在引用時(shí)請(qǐng)?jiān)趍aven中央倉(cāng)庫(kù)搜索最新版本號(hào)--> <version>2.0.4</version> </dependency>
-訪問(wèn)測(cè)試 :http://localhost:8080/doc.html ,可以看到knife4j的界面;
離線文檔導(dǎo)出
Knife4j提供導(dǎo)出4種格式的離線文檔(Html\Markdown\Word\Pdf)
到此這篇關(guān)于springboot集成swagger以及knife4j的增強(qiáng)的文章就介紹到這了,更多相關(guān)springboot集成swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
最簡(jiǎn)單的MyBatis Plus的多表聯(lián)接、分頁(yè)查詢實(shí)現(xiàn)方法
這篇文章主要介紹了最簡(jiǎn)單的MyBatis Plus的多表聯(lián)接、分頁(yè)查詢實(shí)現(xiàn)方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11基于SpringBoot整合SSMP案例(開(kāi)啟日志與分頁(yè)查詢條件查詢功能實(shí)現(xiàn))
這篇文章主要介紹了基于SpringBoot整合SSMP案例(開(kāi)啟日志與分頁(yè)查詢條件查詢功能實(shí)現(xiàn)),本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋參考下吧2023-11-11java 中模擬TCP傳輸?shù)目蛻舳撕头?wù)端實(shí)例詳解
這篇文章主要介紹了java 中模擬TCP傳輸?shù)目蛻舳撕头?wù)端實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-03-03spring配置定時(shí)任務(wù)的幾種方式總結(jié)
這篇文章主要介紹了spring配置定時(shí)任務(wù)的幾種方式總結(jié),具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-12-12Spring Boot Admin管理監(jiān)控?cái)?shù)據(jù)的方法
本篇文章主要介紹了Spring Boot Admin管理監(jiān)控?cái)?shù)據(jù)的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-12-12SpringBoot如何在線程中獲取@Service Bean類(lèi)
這篇文章主要介紹了SpringBoot如何在線程中獲取@Service Bean類(lèi),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02Spring security基于數(shù)據(jù)庫(kù)中賬戶密碼認(rèn)證
這篇文章主要介紹了Spring security基于數(shù)據(jù)庫(kù)中賬戶密碼認(rèn)證,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-03-03java 可重啟線程及線程池類(lèi)的設(shè)計(jì)(詳解)
下面小編就為大家?guī)?lái)一篇java 可重啟線程及線程池類(lèi)的設(shè)計(jì)(詳解)。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-01-01