SpringBoot15：集成Swagger Api问题

项目集成Swagger

学习目标：

了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档Swagger简介

前后端分离

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

产生的问题

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

解决方案

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

Swagger

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

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

Springfox-swagger2swagger-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，测试确保运行成功！

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

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

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

配置Swagger

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

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

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

//配置文档信息

  package com.xuyuan.swaggerdemo.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.ApiSelector;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList;@Configuration
@EnableSwagger2 //开启Swagger2
public class swaggerconfig {@Bean//配置Swagger的Docket的bean实例public Docket docket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo((apiInfo()));}
//配置Swagger信息=apiinfoprivate ApiInfo apiInfo(){Contact apiInfo = new Contact("" + "徐源","https://mp.csdn.net/console/article","826463302@qq.com");return    new ApiInfo("徐源的文档","努力是给有准备的人的","v1.0","https://mp.csdn.net/console/article",apiInfo,"Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0",new ArrayList());}
}

3、Docket 实例关联上 apiInfo()

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

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；
配置扫描接口
1、构建Docket时通过select()方法配置怎么扫描接口。

  @Bean//配置Swagger的Docket的bean实例public Docket docket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口//basePackage指定要扫描的包("com.xuyuan.swaggerdemo.controller")//any:扫描所有的包//none:什么都不扫描//withClassAnnotation:扫描类上的注解  参数是一个注解的反射对象  RestController.class))//withMethodAnnotation:扫描方法上的注解withMethodAnnotation(RequestMapping.class)).apis(RequestHandlerSelectors.basePackage("com.xuyuan.swaggerdemo.controller"))//paths过滤PathSelectors.ant("/xuyuan/**"))只扫描xuyuan下的//.paths(PathSelectors.ant("/xuyuan/**")).build(); //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.kuang.swagger.controller"))// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口.paths(PathSelectors.ant("/xuyuan/**")).build();
}

5、这里的可选值还有

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

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

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

怎样实现项目的生产环境还是开发环境
2、如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？
创建三个properties文件一个dev 一个pro

@Configuration
@EnableSwagger2 //开启Swagger2
public class swaggerconfig {@Bean//配置Swagger的Docket的bean实例public Docket docket(Environment environment){//设置要显示的Swagger 环境Profiles profiles = Profiles.of("dev","test");//通过environment.acceptsProfiles判断是否处在自己环境中boolean b = environment.acceptsProfiles(profiles);//enable 是否启懂swagger   若为false则swagger  不能再浏览器中访问return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(b).select().apis(RequestHandlerSelectors.basePackage("com.xuyuan.swaggerdemo.controller")).build(); //build工厂模式}

配置API分组

 @Bean//配置Swagger的Docket的bean实例public Docket docket(Environment environment){//设置要显示的Swagger 环境Profiles profiles = Profiles.of("dev","test");//通过environment.acceptsProfiles判断是否处在自己环境中boolean b = environment.acceptsProfiles(profiles);//enable 是否启懂swagger   若为false则swagger  不能再浏览器中访问return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(b).groupName("徐源").select().apis(RequestHandlerSelectors.basePackage("com.xuyuan.swaggerdemo.controller")).build(); //build工厂模式}

2、重启项目查看分组

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

@Configuration
@EnableSwagger2 //开启Swagger2
public class swaggerconfig {@Beanpublic  Docket docket1(){return new Docket(DocumentationType.SWAGGER_2).groupName("A");}@Beanpublic  Docket docket2(){return new Docket(DocumentationType.SWAGGER_2).groupName("B");}@Beanpublic  Docket docket3(){return new Docket(DocumentationType.SWAGGER_2).groupName("C");}

4、重启项目查看即可

实体配置
1、新建一个实体类

@ApiModel("用户实体")
public class User {@ApiModelProperty("用户名")public String username;@ApiModelProperty("密码")public String password;
}

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

@RequestMapping("/getUser")
public User getUser(){return new User();
}

3、重启查看测试

注：并不是因为@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("/xuyuan")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){return username;
}

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

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

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

1、默认的访问 http://localhost:8080/swagger-ui.html

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

2、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.1</version>
</dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html

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

4、mg-ui 访问 http://localhost:8080/document.html

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

SpringBoot15：集成Swagger Api问题相关推荐

集成Swagger(API)---SpringBoot
集成Swagger(API) 学习目标: 了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档 Swagger简介前后端分离前端 -> 前端控制层.视图层后端 ...
windows api中文文档_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
gin 生成api文档_golang gin框架集成swagger 自动生成文档
goswagger github仓库html https://github.com/swaggo/swag 安装 swag cligit 1.由于网络缘由,先安装gopm 管理工具github go ...
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案
knife4j knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量, ...
swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
从0到1手把手搭建spring cloud alibaba 微服务大型应用框架（十五） swagger篇 : gateway 集成swagger 与 knife4j实现在线api文档并嵌入到自己项目内
背景我们日常开发中基本都是协同开发的,当然极个别的项目整体前后端都是一个人开发的,当多人协作时,尤其是前后端人员协同开发时必然会面临着前端需要了解后端api接口的情况,两个选择,提前设计好文档,然 ...
Spring Boot集成Restful Api在线文档接口调试工具 Swagger
文章目录一.Swagger简介 Swagger有什么用? 二.环境准备三.构建Spring Boot工程四.引入Swagger依赖五.编写一个Test控制器六.配置Swagger 七.最终测 ...

SpringBoot15：集成Swagger Api问题

SpringBoot15：集成Swagger Api问题相关推荐

最新文章

热门文章