Springboot基础学习之（二十一):Swagger基础学习(swagger信息介绍，配置扫描接口和开关，分组和接口注释）

最新推荐文章于 2025-01-12 23:52:42 发布

不想睡醒的梦

最新推荐文章于 2025-01-12 23:52:42 发布

阅读量4.9k

点赞数 10

分类专栏： spring boot 小白学基础文章标签： spring boot java 框架 swagger2 Api

本文链接：https://blog.youkuaiyun.com/m0_52479012/article/details/130203701

版权

Swagger是一个用于生成、描述、调用和可视化RESTfulWeb服务的框架。它允许通过注解添加接口信息，实现接口文档的实时更新和在线测试。在SpringBoot项目中，通过引入相关依赖，配置Swagger2可以自动生成接口文档和客户端代码，提高开发效率和一致性。Swagger还支持多组配置，可以根据环境动态控制是否启用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

什么是Swagger？

Swagger2是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful 风格的Web 服务

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。这样，如果按照新的开发模式，在开发新版本或者迭代版本的时候，只需要更新Swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。

为什么要使用Swagger？

1：Swagger可以实现注释信息的添加，帮助我们更好的了解到接口信息

2：可以实现接口文档的实时更新

3：通过Swagger接口可以实现在线测试与app postman相似

实施Swagger结构

一：创建一个springboot项目环境(web）

二：导入swagger2需要使用的依赖

    
        <dependencies>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--运行环境-->
        <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
        </dependency>

三：在配置文件对路径进行配置

Springboot2.6以后将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，导致出错


spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

Swagger页面的路径

package springfox.boot.starter.autoconfigure;

import org.springframework.util.StringUtils;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

// tag::swagger-ui-configurer[]
public class SwaggerUiWebMvcConfigurer implements WebMvcConfigurer {
  private final String baseUrl;

  public SwaggerUiWebMvcConfigurer(String baseUrl) {
    this.baseUrl = baseUrl;
  }

  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    String baseUrl = S