Swagger3配置

使用Swagger3去简化以前Swagger2的配置

引入依赖

        <!-- swagger --><dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency><!-- knife4j导出swagger文档 --><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.2</version></dependency>

配置类

package com.tgpms.config;import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import springfox.documentation.builders.*;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;import java.util.ArrayList;
import java.util.Collections;
import java.util.List;/*** swagger3 配置* @author jiangli* @since 2021/1/22 10:04*/
@Configuration
@EnableKnife4j  // 访问路径ip:port/doc.html
public class Swagger3Config {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any()).build()
//                .globalRequestParameters(getGlobalRequestParameters()).globalResponses(HttpMethod.GET, getGlobalResponseMessage()).globalResponses(HttpMethod.POST, getGlobalResponseMessage()).globalResponses(HttpMethod.DELETE, getGlobalResponseMessage()).globalResponses(HttpMethod.PUT, getGlobalResponseMessage())//添加登录认证.securitySchemes(securitySchemes()).securityContexts(securityContexts());}/*** 构建 api文档的详细信息函数,注意这里的注解引用的是哪个*/private ApiInfo apiInfo() {// 获取工程名称String projectName = System.getProperty("user.dir");return new ApiInfoBuilder().title(projectName.substring(projectName.lastIndexOf("\\") + 1) + " API接口文档").contact(new Contact("jl", null, "31346337@qq.com")).version("1.0").description("API文档").build();}//    /**
//     * 生成全局通用参数,按需设置
//     */
//    private List<RequestParameter> getGlobalRequestParameters() {
//        List<RequestParameter> parameters = new ArrayList<>();
//        parameters.add(new RequestParameterBuilder()
//                .name("tfToken")
//                .description("同飞令牌")
//                .required(false)
//                .in(ParameterType.HEADER)
//                .build());
//        return parameters;
//    }/*** 生成通用响应信息*/private List<Response> getGlobalResponseMessage() {List<Response> responseList = new ArrayList<>();responseList.add(new ResponseBuilder().code("404").description("找不到资源").build());return responseList;}/*** 设置授权信息*/private List<SecurityScheme> securitySchemes() {ApiKey apiKey = new ApiKey("tfToken", "token", "header");return Collections.singletonList(apiKey);}/*** 授权信息全局应用*/private List<SecurityContext> securityContexts() {return Collections.singletonList(SecurityContext.builder().securityReferences(Collections.singletonList(new SecurityReference("tfToken", new AuthorizationScope[]{new AuthorizationScope("global", "accessEverything")}))).build());}
}

访问swagger http://localhost:8080/swagger-ui/#/

访问knife4j http://localhost:8080/doc.html

可以设置全局header token 及API文档导出

Swagger3配置相关推荐

Swagger系列——Swagger3配置
Swagger系列--Swagger3配置什么是 Swagger? 依赖引入 springfox引入方式 knife4j引入方式引入美化bootstrap-UI 详细配置 swagger资源访问路 ...
Spring Boot整合Swagger3配置全局Token
应用背景:Swagger配置全局Token的目的在于调用真正接口前会被相关拦截器拦截,拦截器会校验此次访问是否合法,这时配置全局Token的作用就显现出来了,全局Token可以存储所有接口访问时的令牌 ...
SpringBoot2.6.5+Swagger3配置
文章目录 SpringBoot2.6.5+Swagger3 1. 添加Swagger3 pom依赖 2. 添加yml/properties依赖 3. 新建SwaggerConfig配置类 4. 在启动 ...
Spring boot集成Swagger3
一.导入依赖这里以springfox来使用:SpringFox是 spring 社区维护的一个项目(非官方),帮助使用者将 swagger2 集成到 Spring 中.常常用于 Spring 中帮助 ...
swagger配置使用及安全方案
1.swagger的依赖 pom依赖,这是针对swagger2的 <dependency><groupId>io.springfox</groupId><ar ...
springboot集成配置swaggerUI
1.使用swagger的原因手写Api文档的几个痛点: 文档需要更新的时候,需要再次发送一份给前端,也就是文档更新交流不及时. 接口返回结果不明确不能直接在线测试接口,通常需要使用工具,比如pos ...
Swagger3 API接口文档规范课程（Java1234）（内含教学视频+源代码）
Swagger3 API接口文档规范课程(Java1234)(内含教学视频+源代码) 教学视频+源代码下载链接地址:https://download.csdn.net/download/weixin_ ...
Swagger2与Swagger3的演进关系（区别）
一.引入 swagger2需要引入2个jar包,swagger3只需要一个 swagger2 引用两个包 <dependency> <groupId>io.spring ...
Springboot 整合Swagger3 和 Knife4j
前后端分离的项目,接口文档的存在十分重要.与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低.与swagger2相比新版的swa ...

Swagger3配置

Swagger3配置相关推荐

最新文章

热门文章