SpringBoot(8)整合Swagger2

前言

随着互联网技术的发展，一般开发都是前后端分离，那么前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，没有API。
文档工具之前，大家都是手写API文档的，在什么地方书写的都有，有在confluence上写的，有在对应的项目目录下readme.md上写的，每个公司都有每个公司的玩法，无所谓好坏。
但都有一个很大的诟病就是，如果你的接口改动了，那你必须记得去改你的API文档，而Swagger并不需要。swagger就是一款让你更好的书写API文档的框架。

一、pom.xml maven依赖

  <!-- 整合swagger-->
	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger2</artifactId>
		<version>2.6.1</version>
	</dependency>
	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger-ui</artifactId>
		<version>2.6.1</version>
	</dependency>

二、编写配置文件(SwaggerConfig.java)

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;

@EnableSwagger2
@Configuration
public class SwaggerConfig {
    //路径  http://127.0.0.1:8080/swagger-ui.html
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                // 是否开启
                .select()
                // 扫描的路径包
                .apis(RequestHandlerSelectors.basePackage("com.csdn.study.controller"))
                // 指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build()
                .pathMapping("/");
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot-Swagger2")
                .description("lonely feelings")
                // 作者信息
                .contact(new Contact("lonely feelings", "https://blog.csdn.net/", "zwt759025675@163.com"))
                .version("1.0.0")
                .build();
    }
}

三、Controller添加文档内容

1. @Api
2. @ApiOperation

import com.csdn.study.model.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;


@CrossOrigin
@RequestMapping("/user")
@RestController
@Api(description = "用户controller")
public class UserController {

    @ApiOperation(value = "用户展示接口")
    @PostMapping("/shwo")
    public User  shwo(@RequestBody User user){
        return user;
    }

}

四、POJO添加文档内容

1. @ApiModelProperty

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;

@Data
public class User {

    @ApiModelProperty(value="账户")
    @NotEmpty(message = "登陆账号不能为空")
    private String accountName;
    @ApiModelProperty(value="密码")
    @NotEmpty(message = "登陆密码不能为空")
    private String password;
    @ApiModelProperty(value="用户姓名")
    @NotEmpty(message = "用户姓名不能为空")
    private String userName;
}

五、Swagger访问与使用

api首页路径：http://127.0.0.1:8080/swagger-ui.html

结果

作用范围	API	使用位置
对象属性	@ApiModelProperty	用在出入参数对象的字段上
协议集描述	@Api	用于controller类上
协议描述	@ApiOperation	用在controller的方法上
Response集	@ApiResponses	用在controller的方法上
非对象参数集	@ApiImplicitParam	用在@ApiImplicitParams的方法里边
描述返回对象的意义	@ApiModel	用在返回对象类上

常用的注解@Api、@ApiOperation、@ApiModel、@ApiModelProperty示例中有进行标注，对于其他注解，大家可自动谷歌，毕竟常用的就这几个了。有了swagger之后，原本一些post请求需要postman这样的调试工具来进行发起，而现在直接在页面上就可以进行调试了，是不是很爽！对于服务的调用者而已，有了这份api文档也是一目了然，不需要和后端多少沟通成本，按着api说明进行前端开发即可。