SpringBoot集成Swagger2

最新推荐文章于 2025-06-09 14:01:32 发布
原创 最新推荐文章于 2025-06-09 14:01:32 发布 · 1.1k 阅读 · 5 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot

本文详细介绍SpringBoot项目中集成Swagger2的过程，包括热部署配置、Swagger2核心功能及注解使用，演示从零开始创建并测试RESTful API文档。

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

SpringBoot集成Swagger2的使用

1、热部署的问题

什么叫热部署：简单的说就是项目启动之后 如果有更改的内容 项目会自动的实现即时的更新 而不需要从新手动的启动这个项目----热部署

1.1、第一步是导包
  <!--导包
             下面的这个包是咋们开发的时候 需要的所有的工具 在这里面都是有的
             热部署的这个工具也是位于这个包里面
        -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
1.2、配置plugin
 <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
1.3、开启自动编译

file----Settings----Complier

右侧选中自动编译

在这里插入图片描述

1.4、在IDEA设置运行的过程中允许自动编译

操作:ctrl+shirt+alt+/ 选择Registry

在这里插入图片描述

2、手动进行热部署的触发

2.1、导包
  <!--导包
             下面的这个包是咋们开发的时候 需要的所有的工具 在这里面都是有的
             热部署的这个工具也是位于这个包里面
        -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
2.2、配置plugin
 <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>

2.3、配置触发

在这里插入图片描述

2.4、配置选择

在这里插入图片描述

2.5、触发的位置

在这里插入图片描述

3、Swagger2是什么

官方：Swagger是一个规范的、完整的的框架 这个框架主要的功能是生成、描述、调用和可视化的RESFful风格的服务

Swagger是一个生成接口文档、以及接口描述、以及测试的这样一个框架

3.1、前后分离以及给穿戴设备提供接口的分析

在这里插入图片描述

3.2、存在的一些问题

在这里插入图片描述

3.3、Swagger2到底是什么?

这个东西简单的说 就是可以将我们写的这个接口自动生成文档 以及测试环境

4、Swagger2中的一些组件

Swagger是一个开源的项目

Swagger-tools:主要存放的是和Swagger集成和整合的工具

Swagger-core：主要就是整个Swagger的核心

Swagger-js：主要是用在JavaScript上的Swagger实现

Swagger-ui：Swagger自动生成文档的这一部分API

5、Swagger的第一个HelloWorld程序

5.1、导包
 <!--导包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
5.2、编写配置文件
@SpringBootConfiguration       //表明是一个配置文件
@EnableSwagger2                //使能Swagger
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())        //这个方法的作用（生成接口的时候页面显示的信息）
                .select()         //表示的是选择那些路径和API生成文档
                .apis(RequestHandlerSelectors.basePackage("com.qf.springboot.controller"))           //告诉他要扫描的接口存在的这个包
                .paths(PathSelectors.any())          //对所有的API进行监控
                .build();         //构建
    }

    /**
     * 这个方法主要的作用是显示页面上的信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("这里是测试Swagger2的功能文档")    //文档的标题
                .description("这里是NZ1904测试用的")      //文档的描述
                .contact("小波波")                        //作者
                .version("v1.0")                          //版本
                .build();
    }
}
5.3、测试

http://HOST:8080/swagger-ui.html

如果出现Swagger描述的这个页面说明是正确的

5.4、传单无参的写法
 /**
     * 没有参数的玩法
     * @return
     */
    @RequestMapping(value = "test",method = RequestMethod.GET)
    @ApiOperation(value = "测试接口1")
    public RespResult<String> test(){

        RespResult<String> result = new RespResult<>();
        result.setCode(1);
        result.setMsg("请求成功");
        result.setData("xxxxxxxxxxxxxxxxx");

        return  result;
    }
5.5、传递有参数的时候的写法
 /**
     * 有简单参数的玩法
     *    @ApiImplicitParam注解中参数的说明
     *    header：请求的数据放在请求头里面的 就用这个类型
     *    query：请求的参数 放到了请求地址上、配套的（@requestParam）
     *    path：（RestFul中用于面向资源编程的获取数据的方式），配套的获取数据的注解 @PathVarible
     *    body(不会用)
     *    form(基本不用)
     * @return
     */
    @RequestMapping(value = "test1",method = RequestMethod.GET)
    @ApiOperation(value = "测试接口1")
    /**
     * paramType：类型(数据放在那里的问题)
     * name：说明的是参数的名字叫什么
     * value：当前参数的含义
     * required：当前使用这个接口对哦时候 这个参数是不是一定要传
     * dataType：参数的类型
     *
     */
    @ApiImplicitParam(paramType = "query",name = "userName",value = "用户名",required =true,dataType = "String")
    public RespResult<String> test(@RequestParam("userName") String userName){
        RespResult<String> result = new RespResult<>();
        result.setCode(1);
        result.setMsg("请求成功");
        result.setData("xxxxxxxxxxxxxxxxx:"+userName);
        return  result;
    }
5.5、传递多参数的写法
 /**
     * 有多个参数的玩法
     * @return
     */
    @RequestMapping(value = "test4",method = RequestMethod.GET)
    @ApiOperation(value = "测试接口4",notes = "调用当前方法的注意事项")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query",name = "userName",value = "用户名",required =true,dataType = "String"),
            @ApiImplicitParam(paramType = "query",name = "password",value = "密码",required =true,dataType = "String")

    })
    public RespResult<String> test3(@RequestParam("userName") String userName,@RequestParam("password") String password){
        RespResult<String> result = new RespResult<>();
        result.setCode(1);
        result.setMsg("请求成功");
        result.setData("xxxxxxxxxxxxxxxxx:"+userName+"----:"+password);
        return  result;
   }
5.6、传递对象
5.6.1、对象的写法
@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "用户对象")
public class User {
    @ApiModelProperty(value = "用户id")
    private int id;
    @ApiModelProperty(value = "用户名")
    private String userName;
    @ApiModelProperty(value = "密码")
    private String password;
}
5.6.2、方法的写法
    /**
     * 有多个参数的玩法
     * @return
     */
    @RequestMapping(value = "test5",method = RequestMethod.POST)
    @ApiOperation(value = "测试传递对象过来",notes = "调用当前方法的注意事项")
    public RespResult<User> test5(@RequestBody User user){
        RespResult<User> result = new RespResult<>();
        result.setCode(0);
        result.setMsg("请求成功--------");
        result.setData(user);
        return  result;
    }
5.6.3、前后分离请求资源的流程

在这里插入图片描述

5.6.4、Swagger支持token的传输
  @RequestMapping(value = "test6",method = RequestMethod.POST)
    @ApiOperation(value = "测试传递对象过来",notes = "调用当前方法的注意事项")
    @ApiImplicitParam(paramType = "header",name = "token",value = "用户token",required = true,dataType = "String")
    public RespResult<User> test6(@RequestBody User user, HttpServletRequest request){
        String token=request.getHeader("token");
        RespResult<User> result = new RespResult<>();
        result.setCode(0);
        result.setMsg("请求成功--------:"+token);
        result.setData(user);
        return  result;
    }
5.6.5、Swagger如何测试文件的上传
 /**
     * Swagger测试文件上传的方法
     * @param request
     * @param uId
     * @param file
     * @return
     */
    @RequestMapping(value = "fileupload",method = RequestMethod.POST)
    @ApiOperation(value = "测试文件上传",notes = "调用当前方法的注意事项")
    @ApiImplicitParams(
            {
                    @ApiImplicitParam(paramType = "header",name = "token",value = "用户token",required = true,dataType = "String"),
                    @ApiImplicitParam(paramType = "query",name = "uId",value = "用户的id",required = true,dataType = "Integer")
            }
    )
    public RespResult<String> fileupload(HttpServletRequest request,@RequestParam("uId")int uId,@RequestParam("file") MultipartFile file){
        String token=request.getHeader("token");
        RespResult<String> result = new RespResult<>();
        //接下来就可以将文件另存了
        try {
            file.transferTo(new File("G:/bobo.jpg"));
            result.setCode(0);
            result.setMsg("请求成功--------:"+file.getOriginalFilename());
            result.setData("上传是成功的");
        } catch (IOException e) {
            result.setCode(1);
            result.setMsg("上传是失败的:"+e.getMessage());
            result.setData("");
        }
        return  result;
    }

6、Swagger中的一些常用的注解

@Api ：这个注解的主要功能是描述当前的Controller是用来干嘛的
@ApiOperation ：这个注解的主要功能是说明当前接口的作用
@ApiImplicitParam ：这个的主要功能是接口的参数说明
@ApiImplicitParams：多参数的时候使用 参数的说明
@ApiParam ：主要功能也是接口的参数说明
@ApiModel：主要就是对接口中传输的对象的说明
@ApiModelProperty ：这个是接口参数对象中的成员变量的说明
@Apiresponse：返回结果的说明
SpringBoot集成swagger2
m0_37730948的博客
04-20 792
​ 在当今前后端框架流行的时代，一个完整并且规范的接口文档是必不可少的。Swagger是一款Restful接口风格文档在线自动生成、接口功能测试的集成插件，用于生成、描述和可视化Restful风格的Web服务。软件可以实现接口文档同API始终保持同步。同过去的离线接口文档相比起来，整体提高了项目的开发效率，减少了前后端成员之间的非必要沟通。​ 官网地址：https://swagger.io/
spring集成swagger2
BOOM0BOOM的博客
03-19 496
一、配置依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.spr
Spring Boot 整合 swagger3
最新发布
weixin_42638728的博客
06-09 524
return new Docket(DocumentationType.OAS_30)//使用 DocumentationType.OAS_30 指定生成 OpenAPI 3.0 格式的文档；.apiInfo(apiInfo())//通过 .apiInfo(apiInfo()) 设置 API 文档的基本信息（如标题、描述、版本）.paths(PathSelectors.any())//对所有路径的接口都生成文档。对于Spring Boot 2.6+版本，可能需要添加以下配置，解决启动时的路径匹配问题。
Spring集成Swagger2
邢慧鹏的博客
10-27 787
Spring项目集成Swagger，非SpringBoot项目。
springboot集成swagger2
qq_31856061的博客
02-09 580
1.依赖 <!-- swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </depend
SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)
08-30
SpringBoot集成Swagger2实现Restful API并解决类型转换错误 标题解析 本文的标题"SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)"，可以拆分为三个部分：SpringBoot、Swagger2、Restful API。其中，...
SpringBoot集成Swagger2生成接口文档的方法示例
08-26
SpringBoot集成Swagger2生成接口文档的方法是开发RESTful API时常用的一种高效手段，它能够自动生成详细的API文档，便于开发者理解和使用。Swagger2是一个强大的工具，它可以与SpringBoot框架无缝结合，提供实时更新...
springboot整合swagger2
2403_87916407的博客
12-14 1518
Spring Boot 整合 Swagger2 的作用主要体现在以下几个方面：自动生成接口文档：Swagger2 能够根据 Spring Boot 项目中的代码自动生成 RESTful API 文档，减少了手动编写和维护 API 文档的工作量。提高开发效率：通过自动生成的文档，开发人员可以快速了解和测试各个 API 接口的功能和参数，提高了开发效率。减少沟通成本：在前后端分离的开发模式中，Swagger2 提供的在线文档可以减少前后端的沟通成本，帮助新加入项目的同事快速上手业务。
swagger2 整合springmvc
11-23
swagger2整合springmvc最简单的配置 直接解压导入myeclipse, 部署运行，http://localhost:8080/Hi/swagger/index.html 可看效果。
Springfox-swagger2集成SpringBoot2.7.x
baomingshu的博客
04-25 1690
Swagger2是一个用于设计、构建和文档化Web API的工具。它允许开发人员定义API的结构、请求和响应格式，并生成交互式的API文档。开发人员在类上使用注解描述接口，Swagger直接在网页上生成和展示API，使得API的开发和维护更加简单和高效。
SpringBoot 集成Swagger2
02-20 425
SpringBoot 集成Swagger2
springboot2.7接入springfox-swagger2遇到的问题，以及解决方案
热门推荐
zxl_leo的专栏
06-30 1万+
解决springboot2.7 接入springfox-swagger2遇到的问题
【SpringBoot专题_02】springboot集成Swagger详细教程
weixin_40736233的博客
04-16 510
【SpringBoot专题_02】springboot集成Swagger详细教程
swagger 2.10.5 整合 spring boot
qq_19783793的博客
08-29 2167
swagger 整合 spring boot
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值