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的正则表达式深入分析。需要的朋友参考下
    2013-04-04
  • spring boot打包成可执行jar包

    spring boot打包成可执行jar包

    本篇文章主要介绍了spring boot打包成可执行jar包,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • 简单探索 Java 中的惰性计算

    简单探索 Java 中的惰性计算

    这篇文章主要介绍了简单探索 Java 中的惰性计算,惰性计算(尽可能延迟表达式求值)是许多函数式编程语言的特性。惰性集合在需要时提供其元素,无需预先计算它们,这带来了一些好处。,需要的朋友可以参考下
    2019-06-06
  • 基于Java实现二维码的生成和解析

    基于Java实现二维码的生成和解析

    二维码其实就是一种编码技术,只是这种编码技术是用在图片上了,将给定的一些文字,数字转换为一张经过特定编码的图片。本文将利用Java实现二维码的生成和解析,需要的可以参考一下
    2022-08-08
  • SpringBoot+RabbitMQ+Redis实现商品秒杀的示例代码

    SpringBoot+RabbitMQ+Redis实现商品秒杀的示例代码

    本文主要介绍了SpringBoot+RabbitMQ+Redis实现商品秒杀,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Java类加载连接和初始化原理解析

    Java类加载连接和初始化原理解析

    这篇文章主要介绍了Java类加载连接和初始化原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • 利用注解配置Spring容器的方法

    利用注解配置Spring容器的方法

    本篇文章主要介绍了利用注解配置Spring容器的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • 2023最新版IDEA创建javaweb项目的详细图文教程

    2023最新版IDEA创建javaweb项目的详细图文教程

    之前用的社区版IDEA无法部署JavaWeb项目,于是装了一个最新版的IDEA,下面这篇文章主要给大家介绍了关于2023最新版IDEA创建javaweb项目的详细图文教程,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • 从基础到高级详解Java读写Excel公式的实战指南

    从基础到高级详解Java读写Excel公式的实战指南

    这篇文章主要为大家详细介绍了Java使用Spireire.XLSforJava处理Excel公式的方法,涵盖写入、读取、跨工作表引用、日期时间函数等操作,希望对大家有所帮助
    2026-05-05
  • Java源码解析之ConcurrentHashMap

    Java源码解析之ConcurrentHashMap

    今天带大家分析Java源码,文中对Java ConcurrentHashMap介绍的非常详细,有代码示例,对正在学习Java的小伙伴们有很好的帮助,需要的朋友可以参考下
    2021-05-05

最新评论