【Swagger】Springboot中集成Swagger2.0

一、前言

Swagger是一个强大的API文档工具，使用Swagger可以轻松的将后端API的请求条件、所需参数、名称等告知前端的开发人员，可以说是前后端进行沟通的桥梁；在本篇博客中就来介绍一下在Springboot中如何集成Swagger2.0，从而来帮助我们更好的进行开发工作。

二、使用前的准备

在Springboot中集成Swagger2.0，就需要准备Swagger2.0的相关依赖，在这里以Maven项目管理工具来介绍相关的使用，首先我们想要到线上Maven仓库中选取相关的依赖，所需要的依赖文件如下：

		<!--Swagger版本 2.9.2-->
		<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>

三、正式进行开发工作

在项目中引入相关的依赖以后，我们就可以在项目中使用Swagger来对API进行注解说明了，首先我们来创建Swagger的一个配置类，如下所示：

@Configuration
@EnableSwagger2   // 启动Swaggger2的注解
public class commonConfig {	

	@Value("${swagger.config.basePackage}")
	private String basePackage;
	
	@Value("${swagger.config.title}")
	private String title;	
	
	@Value("${swagger.config.description}")
	private String description;
		
	@Value("${swagger.config.version}")
	private String version;
	
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)	//指定API类型为swagger2
				.apiInfo(apiInfo())						//用于定义API文档的相关信息
				.select()//
				.apis(RequestHandlerSelectors.basePackage(basePackage)) //指定controller层包名
				.paths(PathSelectors.any())				//应用于所有的controller
				.build();
	}
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()//
				.title(title)				//API文档的标题
				.description(description)	//关于这个文档作用的描述
				.version(version)			//设置当前API文档的版本号
				.build();
	}
}

由于我是在SpringBoot的配置文件（application.yml）中，进行了相关参数的配置，具体的配置如下：

swagger:
    config:
        basePackage: com.learn.controller
        title: Wechat Login API Document.
        description: Provide wechat login relasted interface.
        version: 1.0

完成了以上的工作以后，我们就可以在进行API开发的时候使用了，先来介绍controller层中的使用，直接上controller层的代码：

@RestController
@Api(value = "WechatLoginController", tags = { "微信登录服务API" })
public class WechatLoginController {
	@Autowired
	private WechatLoginService wechatLoginService;
	
	@Value("${web.backend.redirectUrl}")
	private String webCallbackUrl;
		
	@CrossOrigin
	@RequestMapping(value = "/wechat/login", method = RequestMethod.GET)
	@ApiOperation(value = "构建请求授权URL")
	@ApiImplicitParam(name = "redirect_url", value = "发起微信登录的前端URL", required = true, paramType = "query", dataType = "String")
	public ResponseEntity<String> weChatLogin(@RequestParam("redirect_url") String redirect_url) {
		String takenUrl = wechatLoginService.createWechatAuthorizeUrl(redirect_url);
		return ResponseEntity.ok(takenUrl);
	}
}

接下来介绍Model层的使用，直接上代码：

@Data
@ApiModel(value="WechatUser",description="微信用户信息实体类")
public class WechatUser implements Serializable {

	private static final long serialVersionUID = 1L;
	@ApiModelProperty(value="id",required=true)
	private String id;
	@ApiModelProperty(value="微信用户openId",required=true)
	private String openid; 
	@ApiModelProperty(value="微信用户昵称",required=true)
	private String nickname; 
	@ApiModelProperty(value="微信头像地址",required=true)
	private String headimgurl;
	@ApiModelProperty(value="用户性别1：男性|2：女性|0：未知",required=true)
	private String sex; 
	@Override
	public String toString() {
		return "openid=" + openid 
				+ "&nickname=" + nickname 
				+ "&headimgurl=" + headimgurl
				+ "&sex="+sex;
	}
}

经常要用到的注解如下：

@Api---用在类文件上，一般用于controller层
@ApiOperation---用于方法上，一般用于controller层中的API方法
@ApiImplicitParam---用于方法上，用于对API参数进行标注
@ApiImplicitParams---用于方法上，用于对API参数进行标注，适应于多个参数的情况，使用如下：
@ApiImplicitParams({
			@ApiImplicitParam(...),
			@ApiImplicitParam(...),
			@ApiImplicitParam(...) 
			})
@ApiModel---用于类上，一般用于model层
@ApiModelProperty---用于实体类中的属性上

下面这一组关于注解的详细说明，来源于网络，参考博客：swagger2注解使用教程

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

启动项目，访问对应的链接，如：http://xxxxx:port/swagger-ui.html，显示如下界面：

四、注意

由上图可以看出，我们虽然在model层的实体类上添加了相应的注解，但是并没有显示，出现这个问题的原因是因为虽然在实体类上进行了注解，但是必须在controller层中使用@requestBody注解或者返回的数据类型中包含注解的实体类才可以显示，由于我写的API中没有满足这样的条件，所以没有显示