初步认识Swagger

最新推荐文章于 2025-02-27 13:18:29 发布

田野里的稻草人

最新推荐文章于 2025-02-27 13:18:29 发布

阅读量287

点赞数

本文链接：https://blog.youkuaiyun.com/qq_25447799/article/details/122012524

版权

spring boot 专栏收录该内容

15 篇文章

订阅专栏

文章目录

Swagger简介
Springboot集成Swagger
配置Swagger信息
Swagger配置扫描接口
配置Swagger开关
配置API分组
实体配置
常用注解

Swagger简介

Swagger

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 ==> API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
官网：https://swagger.io/

Springboot集成Swagger

SpringBoot集成Swagger => springfox，两个jar包

Springfox-swagger2
swagger-springmvc

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

3、编写HelloController，测试确保运行成功！

@RestController
public class HelloController {
    @RequestMapping(value = "/hello")
    public String hello(){
        return "hello ";
    }
}

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

   @Configuration //配置类
    @EnableSwagger2// 开启Swagger2的自动配置
    public class SwaggerConfig {  
    }

5、访问测试：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

配置Swagger信息

在SwaggerConfig中进行操作

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

2、可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {
   Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
   return new ApiInfo(
           "Swagger学习", // 标题
           "学习演示如何配置Swagger", // 描述
           "v1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
  );
}

Docket中的常用属性：

   new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .enable(flag)//enable是否启动swagger，如果为false，则为swagger不能再浏览器中访问
                    .select()
                    //RequestHandlerSelectors,配置要扫描接口的方式
                    //basePackage:指定要扫描的包
                    //any():扫描全部
                    //none():不扫描
                    //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
                    //withMethodAnnotation:扫描方法上的注解
                    .apis(RequestHandlerSelectors.basePackage("com.zhu.swagger.controller"))
                    //paths()。过滤什么路径
                    .paths(PathSelectors.ant("/zhu/**"))
                    .build();

3、Docket 实例关联上 apiInfo()

 @Bean
    public Docket docket() {
       return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

完整的代码如下：

  package com.zhu.swagger.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.core.env.Profiles;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    
    @Configuration
    @EnableSwagger2     //开启swagger2
    public class SwaggerConfig {
    
        //配置了swagger的Docker的bean实例
        @Bean
        public Docket docket(Environment environment) {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
        }
    
        //配置文档信息
        private ApiInfo apiInfo() {
            //作者信息
            Contact contact = new Contact("作者名", "http://www.baidu.xom", "2604715338@qq.com");
            return new ApiInfo(
                    "Swagger日志学习", //标题
                    "学习swagger的使用",//描述
                    "v1.0",//版本
                    "http://terms.service/组织连接",//组织连接
                    contact, //作者信息
                    "Apach 2.0 许可",//许可
                    "许可链接", //许可连接
                    new ArrayList<>()//扩展
            );
        }
    }

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；

Swagger配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

  @Bean
    public Docket docket(Environment environment) {
      return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //RequestHandlerSelectors,配置要扫描接口的方式
        //basePackage:指定要扫描的包
        //any():扫描全部
        //none():不扫描
        //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
        //withMethodAnnotation:扫描方法上的注解
        .apis(RequestHandlerSelectors.basePackage("com.zhu.swagger.controller"))
        //paths()。配置如何通过path过滤，即这里只扫描请求以/zhu开头的接口。过滤什么路径
        .paths(PathSelectors.ant("/zhu/**"))
        .build();
    }

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

4、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.zhu.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/zhu/**"))
      .build();
}

5、PathSelectors这里的可选值有：

  any() // 任何请求都扫描
    none() // 任何请求都不扫描
    regex(final String pathRegex) // 通过正则表达式控制
    ant(final String antPattern) // 通过ant()控制

配置Swagger开关

编写application.properties、application-dev.properties、application-pro.properties三个测试文件。

#application.properties
#指定当前的环境为dev
spring.profiles.active=dev 

#application-dev.properties
server.port=8081

#application-pro.properties
server.port=8082

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

  @Bean
        public Docket docket(Environment environment) {
            //设置要显示的swagger环境
            Profiles profiles = Profiles.of("dev", "test");
            //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
            boolean flag = environment.acceptsProfiles(profiles);
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .groupName("张三")
                    .enable(flag)//enable是否启动swagger，如果为false，则为swagger不能再浏览器中访问
                    .select// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                    .apis(RequestHandlerSelectors.basePackage("com.zhu.swagger.controller"))
                    .paths(PathSelectors.ant("/zhu/**"))
                    .build();
        }

2、如何动态配置当项目处于test、dev环境时显示swagger，处于pro时不显示？

 @Bean
    public Docket docket(Environment environment) {
       // 设置要显示swagger的环境
       Profiles of = Profiles.of("dev", "test");
       //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
       boolean flag = environment.acceptsProfiles(profiles);
      
       return new Docket(DocumentationType.SWAGGER_2)
          .apiInfo(apiInfo())
          .enable(flag) //配置是否启用Swagger，如果是false，在浏览器将无法访问
          .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
          .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
           // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
          .paths(PathSelectors.ant("/kuang/**"))
          .build();
    }

配置API分组

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

4、重启项目查看即可

完整代码

package com.zhu.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2     //开启swagger2
public class SwaggerConfig {

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }


    //配置了swagger的Docker的bean实例
    @Bean
    public Docket docket(Environment environment) {
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("张三")
                .enable(flag)//enable是否启动swagger，如果为false，则为swagger不能再浏览器中访问
                .select()
                //RequestHandlerSelectors,配置要扫描接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none():不扫描
                //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
                //withMethodAnnotation:扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.zhu.swagger.controller"))
                //paths()。过滤什么路径
                //.paths(PathSelectors.ant("/zhu/**"))
                .build();
    }

    //配置Swagger信息 = apiInfo
    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact("作者名", "http://www.baidu.xom", "2604715338@qq.com");
        return new ApiInfo(
                "Swagger日志学习", //标题
                "学习swagger的使用",//描述
                "v1.0",//版本
                "http://terms.service/组织连接",//组织连接
                contact, //作者信息
                "Apach 2.0 许可",//许可
                "许可链接", //许可连接
                new ArrayList<>()//扩展
        );
    }
}

实体配置

1、新建一个实体类

 	//给实体类添加文档注释
    //@Api("注释")
    @ApiModel("用户实体类")
    public class Userlogin {
        @ApiModelProperty("用户名")
        public String username;
        @ApiModelProperty("密码")
        public String password;
    }

2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

 //只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger中
     @RequestMapping("/userlogin")
      public Userlogin userlogin(){
          return new Userlogin();
      }

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

常用注解

Swagger的所有注解定义在io.swagger.annotations包下

常用的注解：

Swagger注解简单说明
@Api(tags = "xxx模块说明") 作用在模块类上
@ApiOperation("xxx接口说明") 作用在接口方法上
@ApiModel("xxxPOJO说明") 作用在模型类上：如VO、BO
@ApiModelProperty(value = "xxx属性说明",hidden = true) 作用在类方法和属性上，hidden设置为true可以隐藏该属性 @ApiParam("xxx参数说明") 作用在参数、方法和字段上，类似@ApiModelProperty

我们也可以给请求的接口配置一些注释

@ApiOperation("张三的接口")
@PostMapping("/zhang")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){
   return username;
}

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。