超简单的Swagger快速入门

1、简介

1.1 前后端分离

  前端 -> 前端控制层、视图层
  后端 -> 后端控制层、服务层、数据访问层
  前后端通过API进行交互
  前后端相对独立且松耦合

1.2 存在的问题

  前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发。

1.3 解决方案

  首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险.

1.4 Swagger

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

2、SpringBoot集成Swagger

2.1 前提

  jdk>=1.8,否则swagger2无法运行。

2.2 依赖

<!-- 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>

2.3 Swagger配置类

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

2.4 测试

  创建一个HelloController:

@Controller
@RequestMapping("/test")
public class HelloController {

    @ResponseBody
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
}

  浏览器输入:http://localhost:8080/swagger-ui.html
  可以看到swagger的界面:
在这里插入图片描述

3、Swagger的配置

  Swagger的配置全部在配置类上。

3.1 Docket

  Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。

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

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

3.2 配置文档信息

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

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

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

    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("Meumax", "https://blog.csdn.net/qq_29051413", "578541632@qq.com");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }
}

  配置后的效果:
在这里插入图片描述

3.3 配置扫描接口

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

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

    @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) // 配置文档信息
                .select()   // 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("pers.klb.springswagger.controller"))
                .build();
    }

    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("Meumax", "https://blog.csdn.net/qq_29051413", "578541632@qq.com");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }
}

3.3.1 select()

  select()方法源码定义如下:

public class Docket implements DocumentationPlugin {
	// ...
	public ApiSelectorBuilder select() {
	    return new ApiSelectorBuilder(this);
	}
	// ...
}

  和Docket的其他方法不同,select()方法返回的是一个Builder,也就说调用了这个方法后就不能继续链式调用Docket的其他方法了。
  select()方法的作用是为API选择器初始化一个ApiSelectorBuilder,使得后面可以调用apispaths等方法,最后使用build方法返回一个Docket
  如果觉得看不太明白,可以看源码。

3.3.2 apis(Predicate selector)

  用于配置API接口的扫描范围:

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

    @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo() 
                .select()   
				// 去配置扫描接口,RequestHandlerSelectors配置如何扫描接口	              	
              	.apis(RequestHandlerSelectors.basePackage("pers.klb.springswagger.controller")) 
                .build();
    }
    
}

  RequestHandlerSelectorsPredicate<RequestHandler>的一个实现类,RequestHandlerSelectors的常用方法有:
  1、any():扫描所有,项目中的所有接口都会被扫描到;
  2、none():不扫描任何接口;
  3、withMethodAnnotation():通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求;
  4、withClassAnnotation:通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口;
  5、basePackage():根据包路径扫描接口。

3.3.3 path(Predicate selector)

  apis()方法的返回值为this,也就是说可以回调。
  ApiSelectorBuilder除了apis()还有一个paths(),可以配置接口扫描过滤:

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

  PathSelectorsPredicate<String>的一个实现类,常用方法有:
  1、any():任何请求都扫描;
  2、none():任何请求都不扫描;
  3、regex(final String pathRegex):通过正则表达式控制;
  4、ant(final String antPattern):通过ant()控制只扫描请求以"/**"开头的接口,也就是控制器里面的访问路径。

3.4 配置Swagger开关

  Docket有一个enabled属性,用于控制是否开启Swagger。
  一般来说,我们在开发和测试环境会开启Swagger,在生产环境不会开启。那我们怎么实现这个功能呢?
  1、配置判断条件

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

    @Bean
    public Docket docket(Environment environment) {
        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "test");
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean b = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(b) //配置是否启用Swagger,如果是false,在浏览器将无法访问
                .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("pers.klb.springswagger.controller"))
                // 配置如何通过path过滤,即这里只扫描请求以/hello开头的接口
                .paths(PathSelectors.ant("/hello/**"))
                .build();
    }

    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("Meumax", "https://blog.csdn.net/qq_29051413", "578541632@qq.com");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }
}

  2、如果配置文件的开发环境设置为生产模式:
  application.properties:

spring.profiles.active=prod

  3、启动工程,浏览器输入:http://localhost:8080/swagger-ui.html#/,可以看到:
在这里插入图片描述
  4、配置文件改为开发环境:
  application.properties:

spring.profiles.active=dev

  浏览器访问又可以了:
在这里插入图片描述

3.5 配置API分组

  当然了,我Swagger不可能是一个人用的,是团队开发的,如果有五个人,每个人都会产生一个API页面。我们只需要在Docket设置groupName("klb")即可给自己开发的API命名。
  比如,现在有ABC三个程序员,那么我就定义三个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");
}

  打开Swagger页面,我们就可以看到分组效果:
在这里插入图片描述

4、实体配置

  如果要在Swagger页面的Models上看到我们的实体类,API接口的返回值就必须包含实体类,比如我有一个User实体类:

public class User {
    public String username;
    public String password;
}

  然后控制器的接口必须有返回这个User的:

@Controller
@RequestMapping("/test")
public class HelloController {

    @PostMapping("/user")
    public User user(){
        return new User();
    }

    @ResponseBody
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
}

  查看Swagger页面:
在这里插入图片描述

5、常用注解

  讲了这么多,现在Swagger页面上显示的结果,前端看到表示想打人,为什么呢,因为毫无说明,于是Swagger提供了一系列的注解来让我们在这些API接口和实体类上面标明注释信息。
  Swagger的所有注解定义在io.swagger.annotations包下。

@ApiModel

  作用是给类添加注释信息:

@ApiModel("User实体类")
public class User {
    public  String username;
    public  String password;
}

  效果为:
在这里插入图片描述

@ApiModelProperty

  作用是给类的属性写注释信息:

@ApiModel("User实体类")
public class User {
    @ApiModelProperty("用户名")
    public  String username;

    @ApiModelProperty("密码")
    public  String password;
}

  效果为:
在这里插入图片描述

@Api()

  作用在类上,表示标识这个类是swagger的资源,一般是模块:

@Api(value = "⽤户博客", tags = "博客接⼝")
@Controller
@RequestMapping("/test")
public class HelloController {
	// ...
}

  效果如下:
在这里插入图片描述

@ApiOperation()

  ⽤于⽅法; 表示⼀个http请求的操作:

@Controller
@RequestMapping("/test")
public class HelloController {

    @GetMapping("/detail")
    @ApiOperation(value = "获取⽤户信息", notes = "传⼊notice" , position = 2)
    public User detail(Integer id) {
        return new User();
    }
}

  效果如下:
在这里插入图片描述

@ApiParam()

  ⽤于⽅法,参数,字段说明; 表示对参数的添加元数据(说明或是否必填等)。

@ApiIgnore()

  ⽤于类,⽅法,⽅法参数 表示这个⽅法或者类被忽略;

@ApiImplicitParam()

  ⽤于⽅法,表示单独的请求参数;

@ApiImplicitParams()

  ⽤于⽅法,包含多个 @ApiImplicitParam

小结

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

@Api(value = "⽤户博客", tags = "博客接⼝")
@Controller
@RequestMapping("/test")
public class HelloController {

    @ApiOperation("klb")
    @PostMapping("/klb")
    @ResponseBody
    public String kuang(@ApiParam("这个名字会被返回")String username){
        return username;
    }

  效果如下:
在这里插入图片描述

6、换皮肤

6.1 自带皮肤

  我们可以导入不同的包实现不同的皮肤定义,默认情况下,我们导入的依赖是:

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

  访问路径是:http://localhost:8080/swagger-ui.html

6.2 换成bootstrap

  依赖改为:

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

  访问路径是:http://localhost:8080/doc.html
  效果为:
在这里插入图片描述

6.3 换成Layui-ui

  依赖改为:

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

  访问路径:http://localhost:8080/docs.html

6.4 换成mg-ui

  依赖改为:

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

  访问路径:http://localhost:8080/document.html

  • 3
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值