springboot3使用swagger3

arihara

已于 2024-08-11 00:46:06 修改

阅读量172

点赞数 2

文章标签： spring boot

于 2024-08-11 00:45:01 首次发布

本文链接：https://blog.youkuaiyun.com/arihara/article/details/141098841

版权

只需要添加依赖，其他什么都不需要即可使用

	<dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.0.3</version>
	</dependency>

springboot版本为3.2.8

然后直接访问http://localhost:8080/swagger-ui/index.html#/ 即可

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

arihara

关注关注

2
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Springboot3 配置Swagger3.0版本

梦想的追求

11-07

1094

Springboot3 配置Swargger3.0版本

1、SpringBoot快速整合Swagger3.0

cchqlh的博客

01-26

2359

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件；Swagger的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。

1 条评论您还未登录，请先登录后发表或查看评论

Springboot 配置使用Swagger3

web18334137065的博客

08-02

1313

Swagger是一个可以根据你的代码，自动生成接口文档的一个工具，并且可以用作接口测试工具，2022年了，Swagger也要用3.0版本了吧如果你使用的是Springboot2.6版本，需要配置，否则报下面的错，现在Springboot3.0和Springboot2.5.8不需要配置下面这Causedby启动项目，访问http，注意Swagger3和2访问的页面有细微差别https。...

SpringBoot3使用Swagger3

Q95470的博客

06-17

4038

Swagger是一个用于设计、构建、文档化和使用RESTful Web服务的开源工具。Swagger3是Swagger的最新版本，它提供了许多新功能和改进。Swagger在SpringBoot3中的引入方法发生了改变,网上大部分还是SpringBoot2的版本。访问http://localhost:9090/swagger-ui/index.html#/其中的9090 改成你项目后端使用的端口，注意不能省略后面的index.html。版本也可以使用新版，Springdoc-OpenAPI。

【SpringBoot整合系列】SpringBoot3.x整合Swagger

m0_74824025的博客

03-01

1374

那么问题来了，随着代码的不断更新，开发人员在开发新的接口或者更新旧的接口后，由于开发任务的繁重，往往文档很难持续跟着更新，Swagger 就是用来解决该问题的一款重要的工具，对使用接口的人来说，开发人员不需要给他们提供文档，只要告诉他们一个 Swagger 地址，即可展示在线的 API 接口文档，除此之外，调用接口的人员还可以在线测试接口数据，同样地，开发人员在开发接口时，同样也可以利用 Swagger 在线接口文档测试接口数据，这给开发人员提供了便利。进行方法返回对象的说明。

SpringBoot-Swagger3

qq_44989062的博客

09-02

2008

swagger

spring boot3 集成swagger3

不要和代码过不去

07-20

4456

1 设置pom.xml 主要是引入nexus-maven，com.github.xiaoymin 2个，cn.hutool，org.springframework。2随意位置创建 SwaggerConfig。3修改 DemoApplication。4:给控制文件添加对应注解。

Spring Boot 3项目集成Swagger3教程

interest_ing_的博客

03-07

1万+

Swagger是一个用于设计、构建、记录和使用RESTful web服务的开源软件框架。Swagger 3（OpenAPI 3.0）提供了更加强大和灵活的API文档生成能力。本教程将指导您如何在Spring Boot 3项目中集成Swagger3，并使用Knife4j作为UI界面。

详解如何在SpringBoot里使用SwaggerUI

08-28

3. 测试的时候不需要再使用URL输入浏览器的方式来访问Controller：SwaggerUI提供了交互式的文档，让开发者可以直接在SwaggerUI中测试API接口。 4. 传统的输入URL的测试方式对于post请求的传参比较麻烦：SwaggerUI...

springboot - 2.7.3版本 - （三）整合Swagger3

09-22

在SpringBoot项目中整合Swagger3，可以实现自动化接口文档的生成，为团队协作提供便利。首先，整合Swagger3需要引入相应的依赖。在SpringBoot的`pom.xml`文件中，添加`springdoc-openapi-ui`和`springdoc-openapi-...

springboot3使用swagger文档

m0_60541110的博客

02-06

6573

springboot3.0.2环境下使用swagger生成api文档的教程

springboot 配置使用swagger3

太阳上的雨天

06-03

773

控制器 @Api(tags = “登陆”)swagger 接口文档管理可视化工具。

SpringBoot3整合swagger（springdoc-openapi）

最新发布

03-08

### Spring Boot 3 中配置 Swagger 3 实现接口文档正常访问为了使 Spring Boot 3 和 Swagger 3 正常工作并放行接口文档的访问，需要按照特定的方式添加依赖项和配置。 #### 添加 Maven 依赖对于 Spring Boot 3 版本，推荐使用 `springdoc-openapi` 来替代旧版的 `springfox` 库。以下是适用于 Spring Boot 3 的正确依赖声明： ```xml <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.0.4</version> </dependency> ``` 此依赖会自动配置大多数必要的组件来启动 OpenAPI UI 页面[^1]。 #### 编写配置类 (可选) 通常情况下不需要额外编写配置类，因为 `springdoc-openapi` 已经提供了默认配置。如果确实有自定义需求，则可以通过创建一个 Java 配置文件来进行调整： ```java import org.springframework.context.annotation.Configuration; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Info; @Configuration public class SwaggerConfig { @Bean public OpenAPI customOpenAPI() { return new OpenAPI() .info(new Info().title("My API").version("v1")); } } ``` 这段代码用于设置 API 文档的基础信息，比如标题和版本号[^2]。 #### 安全配置中的路径排除当应用集成了安全框架如 Spring Security 后，需确保 `/swagger-ui.html` 或者新的默认 URL 路径 `/v3/api-docs/**`, `/swagger-ui/index.html` 不被拦截器保护起来。可以在 WebSecurityConfigurerAdapter 继承的安全配置中加入如下规则： ```java @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests() .antMatchers("/v3/api-docs/**", "/swagger-ui/**").permitAll() .anyRequest().authenticated(); } ``` 这一步骤非常重要，它允许未认证用户也能浏览 API 文档页面[^3]。通过以上步骤可以成功地在 Spring Boot 3 上部署并开放访问 Swagger 接口文档的功能。