Springboot集成knife4j实现风格化API文档

 更新时间:2020年12月25日 09:14:00   作者:pengsn  
这篇文章主要介绍了Springboot如何集成knife4j实现风格化API文档,帮助大家更好的使用springboot框架,感兴趣的朋友可以了解下

POM引入插件

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<!--在引用时请在maven中央仓库搜索最新版本号 -->
	<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("视频会议接口描述").
		description("视频会议接口描述").contact(contact).version("1.0").build();
	}
}

注解使用

  • @Api(tags="controller description"); 作用于 类
  • @ApiOperator(value="接口名称", notes="接口描述") 作用于 方法
  • @ApiOperationSupport(order=1) 排序

界面显示

以上就是Springboot集成knife4j实现风格化API文档的详细内容,更多关于Springboot集成knife4j的资料请关注脚本之家其它相关文章!

相关文章

  • Java泛型初学者之上、下界通配符的深入理解

    Java泛型初学者之上、下界通配符的深入理解

    这篇文章主要给大家介绍了关于Java泛型初学者之上、下界通配符的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者实用Java具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-12-12
  • springboot中如何实现kafa指定offset消费

    springboot中如何实现kafa指定offset消费

    这篇文章主要介绍了springboot中如何实现kafa指定offset消费,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • lambda表达式与传统接口函数实现方式对比详解

    lambda表达式与传统接口函数实现方式对比详解

    这篇文章主要为大家介绍了lambda表达式与传统接口函数实现方式对比详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家度偶多进步早日升职加薪
    2022-03-03
  • SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解解读

    SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解解读

    这篇文章主要介绍了SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Java中IO流使用FileWriter写数据基本操作详解

    Java中IO流使用FileWriter写数据基本操作详解

    这篇文章主要介绍了Java中IO流FileWriter写数据操作,FileWriter类提供了多种写入字符的方法,包括写入单个字符、写入字符数组和写入字符串等,它还提供了一些其他的方法,如刷新缓冲区、关闭文件等,需要的朋友可以参考下
    2023-10-10
  • java中CopyOnWriteArrayList源码解析

    java中CopyOnWriteArrayList源码解析

    为了将读取的性能发挥到极致,jdk中提供了CopyOnWriteArrayList类,下面这篇文章主要给大家介绍了关于java中CopyOnWriteArrayList源码解析的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-02-02
  • Java中String.split()的最详细源码解读及注意事项

    Java中String.split()的最详细源码解读及注意事项

    以前经常使用String.split()方法,但是从来没有注意,下面这篇文章主要给大家介绍了关于Java中String.split()最详细源码解读及注意事项的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-07-07
  • Java手动创建线程池代码实例

    Java手动创建线程池代码实例

    这篇文章主要介绍了Java手动创建线程池代码实例,FixedThreadPool或者SingleThreadPool,允许的请求队列长度为Integer.MAX_VALUE,可能会堆积大量的请求,从而导致OOM,需要的朋友可以参考下
    2023-12-12
  • SpringBoot中使用监听器的方法详解

    SpringBoot中使用监听器的方法详解

    这篇文章主要为大家详细介绍了SpringBoot中使用监听器的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java中final,finally,finalize 有什么区别

    Java中final,finally,finalize 有什么区别

    这篇文章主要给大家分享的是 Java中final,finally,finalize 到底有什么区别,文章围绕final,finally,finalize的相关资料展开详细内容,具有一定的参考的价值,需要的朋友可以参考一下
    2021-11-11

最新评论