Java基礎之SpringBoot整合knife4j
更新時間：2021年05月13日 16:58:02 作者：不想做咸魚的王富貴
Swagger現(xiàn)在已經成了最流行的接口文檔生成與管理工具,但是你是否在用的時候也在吐槽,它是真的不好看,接口測試的json數(shù)據(jù)沒法格式化,測試地址如果更改了還要去改配置,接口測試時增加token驗證是真的麻煩…針對Swagger的種種缺點,Knife4j就呼之欲出了.需要的朋友可以參考下
插件的特點
1、非常簡潔清爽的UI設計，接口的快速搜索。
2、支持個性化設置，個性化設置包含：
請求參數(shù)緩存 動態(tài)請求參數(shù) RequestMapping接口過濾 HOST代理設置
3、全局參數(shù)設置，可以很方便的設置Token等權限認證參數(shù)。
4、離線API文檔下載：
Markdown（已支持） Html（已支持） Word（已支持） OpenApi（已支持）
5、對 json 格式的數(shù)據(jù)有更好的支持，可以折疊展開等。
knife4j官方文檔地址 ： https://doc.xiaominfo.com/knife4j/
導入pom依賴
<!--lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<!--在引用時請在maven中央倉庫搜索最新版本號-->
<version>2.0.2</version>
</dependency>
/**
* 訪問地址 http://127.0.0.1:2888/doc.html
*/
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.useDefaultResponseMessages(false)
.apiInfo(apiInfo())
.select()
//方式一: 配置掃描 所有想在swagger界面的統(tǒng)一管理接口。都必須在此包下
//.apis(RequestHandlerSelectors.basePackage("com.baozun.dma.collection.delivery.controller"))
//方式二: 只有當方法上有 @ApiOperation 注解時才能生成對應的接口文檔
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Knife4j APIs")
.description("swagger-bootstrap-ui")
.termsOfServiceUrl("http://localhost:2888/")
.version("1.0")
.build();
}
}
/**
* 數(shù)據(jù)關系投遞Controller
* @author: wys
* @create: 2021-05-08 14:20
**/
@Api(value = "數(shù)據(jù)關系投遞接口", tags = "數(shù)據(jù)關系投遞接口")
@RestController("/MappingRelation")
public class MappingRelationController {
@Autowired
private MappingRelationManager mappingRelationManager;
@GetMapping("/findList")
@ApiOperation(value = "查看數(shù)據(jù)關系", tags = "數(shù)據(jù)關系投遞接口")
public List<MappingRelationManager> findList(){
List<MappingRelationManager> list = mappingRelationManager.ListMappingRelation();
return list;
}
}
訪問路徑：http://127.0.0.1:2888/doc.html
到此這篇關于Java基礎之SpringBoot整合knife4j的文章就介紹到這了,更多相關SpringBoot整合knife4j內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家詳細介紹了Java實現(xiàn)五子棋AI算法，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-03-03
這篇文章主要介紹了Java中線程Thread的三種方式和對比，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-04-04
這篇文章主要介紹了Java基于解釋器模式實現(xiàn)定義一種簡單的語言功能,簡單描述了解釋器模式的概念、功能及Java使用解釋器模式定義一種簡單語言的相關實現(xiàn)與使用技巧,需要的朋友可以參考下2021-10-10
今天小編就為大家分享一篇關于Java垃圾回收之分代收集算法詳解，小編覺得內容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-10-10
這篇文章主要介紹了使用idea將工具類打包使用的詳細教程,本文通過圖文并茂給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
這篇文章對Java編程語言的基礎知識作了一個較為全面的匯總，在這里給大家分享一下。需要的朋友可以參考，希望能給你帶來幫助2021-08-08
這篇文章主要介紹了通過實例了解JavaStream流的方法學習和總結,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2021-08-08
Struts2提供的文件上傳下載機制十分簡便，使得我們寫很少的代碼，下面這篇文章主要給大家介紹了關于Struts2學習手冊之文件上傳的相關資料，文中通過示例代碼介紹的非常詳細，需要的朋友可以參考下2018-05-05
這篇文章主要介紹了java構造器復用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03
文章介紹了SpringBoot項目的兩種部署方式：Docker容器部署和FatJar直接部署,FatJar部署存在配置文件隱藏和啟動腳本復雜的問題,而Assembly打包方式可以解決這些問題,使得SpringBoot能夠加載jar外的配置文件并提供服務化的啟動腳本2024-12-12