Springboot 整合Swagger 2框架让接口查看及调试更加优雅

我不是女神ヾ 2021-12-21 04:25 223阅读 0赞

先是pom.xml文件添加依赖：

<dependency>
    			<groupId>io.springfox</groupId>
    			<artifactId>springfox-swagger2</artifactId>
    			<version>2.8.0</version>
    		</dependency>
    		<dependency>
    			<groupId>io.springfox</groupId>
    			<artifactId>springfox-swagger-ui</artifactId>
    			<version>2.8.0</version>
    		</dependency>

application.yml不需要做配置

接着是Swagger2的配置类  Swagger2Config.java：

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /**
     * @Author：JCccc
     * @Description：
     * @Date： created in 20:50 2019/5/25
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2Config extends WebMvcConfigurationSupport {
    
        /**
         * 因为 Swagger2的资源文件都是在jar包里面，如果不在此处配置加载静态资源，
         * 会导致请求http://localhost:8081/swagger-ui.html失败
         *  
         *  <mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
         *  <mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
         *
         * @param registry
         */
        @Override
        protected void addResourceHandlers(ResourceHandlerRegistry registry) {
            registry.addResourceHandler("swagger-ui.html")
                    .addResourceLocations("classpath:/META-INF/resources/");
    
            registry.addResourceHandler("/webjars/**")
                    .addResourceLocations("classpath:/META-INF/resources/webjars/");
        }
    
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.soelegant.elegantdemo.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    //不需要时，或者生产环境可以在此处关闭
                    .enable(true);
    
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("JCccc springboot整合Swagger2项目 ")
                    .description("描述：测试使用Swagger2！")
                    //服务条款网址
                    .termsOfServiceUrl("https://blog.csdn.net/qq_35387940")
                    .contact("JCccc")
                    .version("1.0")
                    .build();
        }
    
    
    
    }

然后是写一个Controller ，整合Swagger2框架注解 Swagger2TestController.java：

import com.alibaba.fastjson.JSONObject;
    import com.soelegant.elegantdemo.pojo.UserInfo;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.*;
    
    /**
     * @Author：JCccc
     * @Description：
     * @Date： created in 20:54 2019/5/25
     */
    @Api(value = "测试各种方法", tags = {"测试使用Controller"})
    @RestController
    public class Swagger2TestController {
    
        @ApiOperation(value = "测试Swagger2接口", notes = "传入编号！")
        @ApiImplicitParam(name = "id", value = "id", required = true)
        @RequestMapping(value = "/swaTest2/{id}", method = RequestMethod.GET)
        public String TestSwa2(@PathVariable("id") Integer id) {
            System.out.println("swaTest！");
            //  Optional<UserInfo> user = userRepository.findById(id);
            UserInfo userInfo = new UserInfo();
            userInfo.setUsername("test");
            userInfo.setState(1);
            userInfo.setPassword("123456");
            userInfo.setNickName("testNickName");
            userInfo.setIsDeleted(id);
            userInfo.setIds(null);
            userInfo.setIdList(null);
            return userInfo.toString();
        }
    
    
        @ApiOperation(value = "swaTest3", notes = "测试GET！")
        @ApiImplicitParam(name = "name", value = "用户name")
        @RequestMapping(value = "/swaTest3", method = RequestMethod.GET)
        public String TestSwa3(@RequestParam("name") String name) {
            System.out.println("swaTest！");
    
    
            return name;
        }
    
    
        @ApiOperation(value = "swaTest4", notes = "测试POST！")
        @RequestMapping(value = "/swaTest4", method = RequestMethod.POST)
        public String TestSwa4(@RequestBody JSONObject jsonObject) {
            System.out.println("swaTest4！" + jsonObject.toString());
    
            String str = jsonObject.toString();
            return str;
        }
    
    
    
        @ApiOperation(value = "swaTest5", notes = "测试对象传值！")
        @RequestMapping(value = "/swaTest5", method = RequestMethod.POST)
        public String TestSwa5(UserInfo userInfo) {
    
            return userInfo.toString();
        }
    
    }

可以看到上面的第一个接口用到了UserInfo实体类， 那么我们也将这个跟接口有关的类也结合Swagger2注解  UserInfo.java：

import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.Data;
    
    import java.io.Serializable;
    import java.util.List;
    
    /**
     * @Author：JCccc
     * @Description：
     * @Date： created in 20:57 2019/5/25
     */
    @Data
    @ApiModel(value = "userInfo 对象",description = "用户对象user")
    public class UserInfo implements Serializable {
        private static final long serialVersionUID = 1L;
        @ApiModelProperty(value="用户名",name="username",example="lx")
        private String username;
        @ApiModelProperty(value="状态",name="state",required=true)
        private Integer state;
        private String password;
        private String nickName;
        private Integer isDeleted;
    
        @ApiModelProperty(value="id数组",hidden=true)
        private String[] ids;
        private List<String> idList;
    
    
    
    }

那么到此，我们整合Swagger2基本已经完毕，接下来看看效果：

运行项目后，进入Swagger2的接口页面：[http://localhost:8099/swagger-ui.html\#][http_localhost_8099_swagger-ui.html]      （端口就是自己项目的端口，我自己的是8099）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70][]

然后可以点开接口看看，顺便还可以在线调试（点开接口，点击Try it out）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 1][]

然后/swaTest4这个接口是通过@RequestBody JSONObject jsonObject 接收参数，所以在Swagger2的接口页面上，我们也传入一个json格式数据：

\{  
  "userName": "testName",  
  "userId":"22222222"  
\}

如图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 2][]

点击Execute进行接口调用，可以看到接口返回：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 3][]

OK，本篇springboot整合Swagger2 到此结束。

[http_localhost_8099_swagger-ui.html]: http://localhost:8099/swagger-ui.html#
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70]: /images/20211221/8bfcaa6ee49f40edaf3197dc0c5dd82b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 1]: /images/20211221/e279e50aed0d48ff9a00c8ecf39636c2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 2]: /images/20211221/50e0ca9d91b542c499b2fbeca63cd839.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 3]: /images/20211221/e2969d22e35046fba1fd37ca9ce47386.png

发表评论取消回复

表情：

评论列表（有 0 条评论，223人围观）

还没有评论，来说两句吧...

相关阅读

相关 SpringBoot整合Swagger2，让接口文档管理变得更简单

在软件开发的过程中，接口文档的编写往往是一个非常重要的环节，因为它是前端和后端沟通的桥梁，帮助团队更好地协作。然而，手动编写接口文档不仅耗费时间，还容易出错，因此我们需要一种简

蔚落/ 2023年10月10日 18:17/ 0 赞/ 41 阅读

相关 SpringBoot整合Swagger2接口文档

一、添加依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui

Love The Way You Lie/ 2023年10月06日 22:06/ 0 赞/ 39 阅读

相关 SpringBoot整合Swagger2接口API

一、导入maven包　　 <dependency> <groupId>io.springfox</groupId> <artifact

小咪咪/ 2022年12月19日 09:16/ 0 赞/ 242 阅读

相关 SpringBoot整合Swagger2生成接口API文档

前言：Swagger2是一个能够帮助我们快速生成RESTful接口API文档的一个工具，你可以在控制器上写上接口描述，参数描述等等，在生成的Swagger2接口文档中都有体现，

r囧r小猫/ 2022年12月07日 12:08/ 0 赞/ 320 阅读

相关 SpringBoot整合Swagger2生成接口文档

文章目录一、导入依赖二、配置Swagger类三、启动访问四、Swagger2注解详解五、把S

青旅半醒/ 2022年12月03日 09:08/ 0 赞/ 352 阅读

相关 springboot整合swagger2

基础配置：一、 pom.xml中引入swagger的依赖  <dependency>

矫情吗；*/ 2022年09月08日 10:27/ 0 赞/ 323 阅读

相关 SpringBoot整合Swagger2

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。是一套流行的API框架，可以帮助开发人员快速构建API文档，还可以方便测试项目

素颜马尾好姑娘i/ 2022年04月14日 02:37/ 0 赞/ 381 阅读

相关 Springboot 整合Swagger 2框架让接口查看及调试更加优雅

先是pom.xml文件添加依赖：  <dependency> <groupId>io.springfox</g

我不是女神ヾ/ 2021年12月21日 04:25/ 0 赞/ 224 阅读

相关 Springboot整合Swagger2

一、什么是Swagger2？ Swagger是一个RESTFUL 接口的文档在线自动生成和功能测试的框架。 Swagger 是一个规范和完整的框架。用于生成、描述、调用

客官°小女子只卖身不卖艺/ 2021年12月17日 12:27/ 0 赞/ 432 阅读

相关 SpringBoot整合Swagger2

手写Api文档的几个痛点： 1. 文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。 2. 接口返回结果不明确 3. 不能直接在线测试接口，通常需要

女爷i/ 2021年11月26日 10:28/ 0 赞/ 477 阅读