Spring Boot整合Swagger3、Knife4j

Swagger在配置类中写法

启动项目直接访问 ip:端口号/路径

比如:

Swagge在线接口文档访问路径: ip:端口号/swagger-ui/index.html

Knife4j在线接口文档访问路径: ip:端口号/doc.html

springboot版本太高的话可能会导致不兼容(2.6以上)

依赖

<!--swagger2 依赖-->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>3.0.0</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>3.0.0</version><scope>compile</scope>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version>
</dependency>
<!--整合Knife4j-->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.3</version>
</dependency>
<!--如果SpringBoot版本大于2.3则需要引入下面依赖-->
<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version>
</dependency>

配置类

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration //配置类
//@EnableSwagger2 //swagger注解
@EnableOpenApi //开启swagger注解
@EnableKnife4j
public class SwaggerConfig {@Beanpublic Docket createDocket(){//添加摘要信息ApiInfoBuilder apiInfoBuilder=new ApiInfoBuilder();ApiInfo apiInfo = apiInfoBuilder//设置标题.title("在线接口文档")//描述.description("API在线接口文档管理")//版本.version("1.0.0")//作者信息.contact(new Contact("admin", null, null)).build();return new Docket(DocumentationType.OAS_30)//是否启用Swagger.enable(true)//用来创建该API的基本信息，展示在文档的页面中(自定义展示的信息).apiInfo(apiInfo)//设置哪些接口暴露给Swagger展示.select()// 扫描所有.apis(RequestHandlerSelectors.any())//扫描指定包中的swagger注解//.apis(RequestHandlerSelectors.basePackage("com.csdn.controller"))//扫描所有有注解的api，用这种方式更灵活//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));.paths(PathSelectors.any()).build();}
}

Spring Security 安全框架需要放行路径

@Override
protected void configure(HttpSecurity http) throws Exception {http//关闭csrf.csrf().disable()//不通过Session获取SecurityContext.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and().authorizeRequests()// 对于注册和登录接口 允许匿名访问.antMatchers("/login","/register").anonymous()//放行swagger3、Knife4j
//                .antMatchers("/swagger-ui.html","/swagger-ui/index.html","/swagger-resources/**","/swagger-ui/**","/webjars/**","/v3/**","/api/**").permitAll().antMatchers("/swagger-ui/**", "/swagger-resources/**", "/v3/**","/doc.html","/webjars/**","/favicon.ico", "/img.icons/**").permitAll()// 除上面外的所有请求全部需要鉴权认证.anyRequest().authenticated();//把token校验过滤器添加到过滤器链中http.addFilterBefore(tokenFilter, UsernamePasswordAuthenticationFilter.class);//配置异常处理器http.exceptionHandling()//配置登陆失败处理器.authenticationEntryPoint(authenticationEntryPoint);//允许跨域http.cors();
}

Spring Boot整合Swagger3、Knife4j相关推荐

Spring Boot整合Swagger3配置全局Token
应用背景:Swagger配置全局Token的目的在于调用真正接口前会被相关拦截器拦截,拦截器会校验此次访问是否合法,这时配置全局Token的作用就显现出来了,全局Token可以存储所有接口访问时的令牌 ...
Spring Boot整合Swagger3注解@ApiImplicitParam的paramType属性为“path“
Spring Boot整合Swagger3的依赖版本为:  <dependency><groupId> ...
Spring Boot整合Swagger3注解@ApiImplicitParam的allowMultiple属性
Spring Boot整合Swagger3的依赖版本为:  <dependency><groupId> ...
Spring Boot整合Swagger3
第一步:引入SpringBoot整合Swagger2的最版版本3.0.0,目前的更新时间为2020年7月  <depe ...
Spring Boot整合Swagger3的分组问题
Swagger3如果没有设置分组,则所有的API接口全在一个default分组中,如下所示: 但是如果功能模块和接口数量逐渐增多时,就会显得有些凌乱,不方便查找和使用,这时可提供的解决方法就是对API ...
spring boot整合spring security笔记
最近自己做了一个小项目,正在进行springboot和spring Security的整合,有一丢丢的感悟,在这里分享一下: 首先,spring boot整合spring security最好是使用T ...
RabbitMQ使用及与spring boot整合
1.MQ 消息队列(Message Queue,简称MQ)--应用程序和应用程序之间的通信方法应用:不同进程Process/线程Thread之间通信比较流行的中间件: ActiveMQ Rabbi ...
Spring Boot 教程（三）： Spring Boot 整合Mybatis
教程简介本项目内容为Spring Boot教程样例.目的是通过学习本系列教程,读者可以从0到1掌握spring boot的知识,并且可以运用到项目中.如您觉得该项目对您有用,欢迎点击收藏和点赞按钮, ...
五、spring boot整合mybatis-plus
spring boot整合mybatis-plus 简介 mybatis 增强工具包,简化 CRUD 操作. 文档 http://mp.baomidou.com http://mybatis.plus ...

Spring Boot整合Swagger3、Knife4j

Spring Boot整合Swagger3、Knife4j相关推荐

最新文章

热门文章