Springboot集成knife4j實(shí)現(xiàn)風(fēng)格化API文檔
更新時(shí)間:2020年12月25日 09:14:00 作者:pengsn
這篇文章主要介紹了Springboot如何集成knife4j實(shí)現(xiàn)風(fēng)格化API文檔,幫助大家更好的使用springboot框架,感興趣的朋友可以了解下
POM引入插件
<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.3</version> </dependency>
配置加載
package com.pengsn.apiserver.videoconference.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;
/**
* 配置
*/
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select()
// 這里指定Controller掃描包路徑
.apis(RequestHandlerSelectors.basePackage(
"com.pengsn.apiserver.videoconference.business"))
.paths(PathSelectors.any()).build();
return docket;
}
private ApiInfo apiInfo() {
Contact contact = new Contact("pengsn", "", "");
return new ApiInfoBuilder().title("視頻會(huì)議接口描述").
description("視頻會(huì)議接口描述").contact(contact).version("1.0").build();
}
}
注解使用
- @Api(tags="controller description"); 作用于 類
- @ApiOperator(value="接口名稱", notes="接口描述") 作用于 方法
- @ApiOperationSupport(order=1) 排序
界面顯示

以上就是Springboot集成knife4j實(shí)現(xiàn)風(fēng)格化API文檔的詳細(xì)內(nèi)容,更多關(guān)于Springboot集成knife4j的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Java編程中靜態(tài)內(nèi)部類與同步類的寫法示例
這篇文章主要介紹了Java編程中靜態(tài)內(nèi)部類與同步類的寫法示例,用于構(gòu)建靜態(tài)對(duì)象以及實(shí)現(xiàn)線程同步等,需要的朋友可以參考下2015-09-09
Java編程數(shù)組中最大子矩陣簡(jiǎn)便解法實(shí)現(xiàn)代碼
這篇文章主要介紹了Java編程數(shù)組中最大子矩陣簡(jiǎn)便解法實(shí)現(xiàn)代碼,小編覺(jué)得還是挺不錯(cuò)的,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01
使用maven創(chuàng)建普通項(xiàng)目命令行程序詳解
大部分使用maven創(chuàng)建的是web項(xiàng)目,這里使用maven創(chuàng)建一個(gè)命令行程序,目的是讓大家了解maven特點(diǎn)和使用方式,有需要的朋友可以借鑒參考下2021-10-10
JAVA生產(chǎn)者消費(fèi)者(線程同步)代碼學(xué)習(xí)示例
這篇文章主要介紹了JAVA線程同步的代碼學(xué)習(xí)示例,大家參考使用吧2013-11-11
Java Swing編寫一個(gè)簡(jiǎn)單的計(jì)算器軟件
大家好,本篇文章主要講的是Java Swing編寫一個(gè)簡(jiǎn)單的計(jì)算器軟件,感興趣的同學(xué)趕快來(lái)看一看吧,對(duì)你有幫助的話記得收藏一下,方便下次瀏覽2021-12-12

