springboot集成swagger3

简介: pom直接引用springfox-boot-starter,swagger3不需要引用ui包。

pom直接引用springfox-boot-starter,swagger3不需要引用ui包。

<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency>

开始相关配置,创建config配置类。

importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importspringfox.documentation.builders.ApiInfoBuilder;
importspringfox.documentation.builders.PathSelectors;
importspringfox.documentation.builders.RequestHandlerSelectors;
importspringfox.documentation.oas.annotations.EnableOpenApi;
importspringfox.documentation.service.ApiInfo;
importspringfox.documentation.spi.DocumentationType;
importspringfox.documentation.spring.web.plugins.Docket;
/*** @author lhq*/@EnableOpenApi@ConfigurationpublicclassSwaggerConfig {
@BeanpublicDocketcreateRestApi() {
returnnewDocket(DocumentationType.OAS_30)
                .apiInfo(buildApiInfo())
                .enable(true)
                .select()
// 要扫描的API(Controller)基础包                .apis(RequestHandlerSelectors.basePackage("com.hsrc.fjyc.intelligentassistant.controller"))
                .paths(PathSelectors.any())
                .build();
    }
privateApiInfobuildApiInfo() {
returnnewApiInfoBuilder()
                .title("stoneAPI文档")
                .description("平台管理服务api")
                .version("1.0.0")
                .build();
    }
}

注意:new Docket(DocumentationType.OAS_30)这里不再使DocumentationType.SWAGGER_2,从swagger2切换过来的一定小心,不然可能无法识别相关请求,加载一个空页面。

注解使用:@Tag代替@Api,其中name的值一定是类名小写,类名中间存在大写的用横线间隔开,大写变小写。

/*** 会话相关* @author lhq*/@Tag(description="会话相关",name="chatbot-controller")
@RestControllerpublicclassChatbotController {
privateLoggerlogger=LogManager.getLogger(ChatbotController.class);
@ResourceAlibabaUtillalibabaUtill;
@ResourceJwtUtiljwtUtil;
@Operation(summary="获取热点(大家都在看)")
@ApiResponses({
@ApiResponse(responseCode="200",description="成功",ref="成功"),
@ApiResponse(responseCode="400",description="失败",ref="失败")
    })
@PostMapping("/hotKnowledge")
publicStringhotKnowledge(@Parameter(name="token",description="调用请求的令牌;",required=true) @RequestParam(value="token")Stringtoken,
@Parameter(name="limit",description="总条数",required=true) @RequestParam(value="limit") Stringlimit){

这时候直接访问时注意,要带完整的路径/swagger-ui/index.html。否则可能找不到,想要可以直接输入/swagger-ui就可以访问,需要配置拦截,对/swagger-ui路径,直接跳转到/swagger-ui/index.html。

相关文章
|
2月前
|
Java Maven Docker
gitlab-ci 集成 k3s 部署spring boot 应用
gitlab-ci 集成 k3s 部署spring boot 应用
|
11天前
|
XML Java API
Spring Boot集成MinIO
本文介绍了如何在Spring Boot项目中集成MinIO,一个高性能的分布式对象存储服务。主要步骤包括:引入MinIO依赖、配置MinIO属性、创建MinIO配置类和服务类、使用服务类实现文件上传和下载功能,以及运行应用进行测试。通过这些步骤,可以轻松地在项目中使用MinIO的对象存储功能。
|
13天前
|
消息中间件 Java Kafka
什么是Apache Kafka?如何将其与Spring Boot集成?
什么是Apache Kafka?如何将其与Spring Boot集成?
44 5
|
15天前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
29 4
|
15天前
|
消息中间件 Java Kafka
Spring Boot 与 Apache Kafka 集成详解:构建高效消息驱动应用
Spring Boot 与 Apache Kafka 集成详解:构建高效消息驱动应用
23 1
|
1月前
|
XML Java 数据库连接
SpringBoot集成Flowable:打造强大的工作流管理系统
在企业级应用开发中,工作流管理是一个核心组件,它能够帮助我们定义、执行和管理业务流程。Flowable是一个开源的工作流和业务流程管理(BPM)平台,它提供了强大的工作流引擎和建模工具。结合SpringBoot,我们可以快速构建一个高效、灵活的工作流管理系统。本文将探讨如何将Flowable集成到SpringBoot应用中,并展示其强大的功能。
110 1
|
2月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
66 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
16天前
|
消息中间件 监控 Java
您是否已集成 Spring Boot 与 ActiveMQ?
您是否已集成 Spring Boot 与 ActiveMQ?
30 0
|
1月前
|
JSON Java API
springboot集成ElasticSearch使用completion实现补全功能
springboot集成ElasticSearch使用completion实现补全功能
40 1
|
1月前
|
XML 存储 Java
SpringBoot集成Flowable:构建强大的工作流引擎
在企业级应用开发中,工作流管理是核心功能之一。Flowable是一个开源的工作流引擎,它提供了BPMN 2.0规范的实现,并且与SpringBoot框架完美集成。本文将探讨如何使用SpringBoot和Flowable构建一个强大的工作流引擎,并分享一些实践技巧。
85 0

热门文章

最新文章