SpringBoot如何集成Swagger2

雨点打透心脏的1/2处 2023-10-05 10:10 46阅读 0赞

现在开发大多都是基于前后端分离，传统编写和维护接口文档及测试已经不能满足前后端各自开发的需要，因此swagger2的出现便解决了这一困扰，并且也能减少后端的工作量

一、swagger2是什么？  
swagger2 是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的web服务

二、集成swagger2步骤

1.  添加依赖

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>

1.  编写swagger2配置类（与项目启动类平级）

@Configuration
    @EnableSwagger2//开启swagger2注解
    public class SwaggerConfig {
        
        @Bean
        public Docket createRestApi() {
        
            return new Docket(DocumentationType.SWAGGER_2)
                    // 接口文档的基本信息
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.springcloud"))
                    // 路径使用any风格
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
        
            return new ApiInfoBuilder()
                    .title("SpringCloud接口文档")
                    .description("SpringCloud接口文档说明")
                    .version("1.0")
                    .build();
        }
    }

1.  在controller类上加入swagger2注解（这里只做简单地测试）

@Api(tags = "用户表")
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
    
        @ApiOperation(value = "查询所有用户",notes = "这是用来查询所有用户列表")
        @GetMapping("/users")
        public Object findAll(@RequestParam(required = false,defaultValue = "",value = "主键") String id,
                              @RequestParam(required = false,defaultValue = "",value = "姓名")String name){
        
            ModelMap map=new ModelMap();
            map.addAttribute("msg","查询成功");
            map.addAttribute("id",id);
            map.addAttribute("name",name);
            map.addAttribute("code",0);
            return map;
        }
    }

1.  启动项目、访问 http://localhost:9090/swagger-ui.html  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTcwODc5_size_16_color_FFFFFF_t_70_pic_center]

到这里swagger已经集成好了，下面讲一下常用的swagger2的注解

@Api：用在请求的类上，表示对类的说明
      1.     tags="说明该类的作用，可以在UI界面上看到的注解"
      2.     value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
    
    
    @ApiOperation：用在请求的方法上，说明方法的用途、作用
      1.     value="说明方法的用途、作用"
      2.     notes="方法的备注说明"
    
    @ApiImplicitParams：用在请求的方法上，表示一组参数说明
      1.     @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
      2.         name：参数名
      3.         value：参数的汉字说明、解释
      4.         required：参数是否必须传
      5.         paramType：参数放在哪个地方
                          · header --> 请求参数的获取：@RequestHeader
                          · query --> 请求参数的获取：@RequestParam
                ·           path（用于restful接口）--> 请求参数的获取：@PathVariable
                ·           body（不常用）
                        ·   form（不常用）    
      6.         dataType：参数类型，默认String，其它值dataType="Integer"       
      7.         defaultValue：参数的默认值
    
    
    @ApiResponses：用在请求的方法上，表示一组响应
      1.     @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
      2.         code：数字，例如500
      3.         message：信息，例如"请求失败"
    
    @ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用              
    @RequestBody这样的场景，求参数无法使用@ApiImplicitParam注解进行描述的时候）
      1.     @ApiModelProperty：用在属性上，描述响应类的属性

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTcwODc5_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/2020091709280441.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTcwODc5,size_16,color_FFFFFF,t_70#pic_center