SpringBoot项目集成Swagger2

Swagger是什么?

Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。

Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。

Swagger 是一种通用的，和编程语言无关的 API 描述规范。

为什么要使用Swagger?

很多时候自己手动维护一份api文档需要花费大量的时间和精力;而且常常会因为一些的临时的、不在计划内的api修改后忘记更新api文档影响前端开发;前端程序员不能及时获取到最新的的api文档等等问题,而Swagger能解决这个问题.

pom引入

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

创建Swagger配置类

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author Vic.Douglas
 * @date 2019-06-19 22:12:31
 */
@Configuration
public class Swagger2 {

	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.victor.douglas.XXXXX"))//你项目的包名,要不然Swagger不能找到你的api
				.paths(PathSelectors.any())
				.build();
	}
	
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("XX-api文档")
				.description("")
				.termsOfServiceUrl("https://me.csdn.net/PCKNO_1")
				.version("1.0")
				.build();
	}
}

 在Controller中使用

@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：用在属性上，描述响应类的属性

例子

@Api(value = "商户类型",tags = "商户类型")
@RequestMapping(value = "/shopClassify")
@RestController
public class ShopClassifyController {
    @Autowired
    private ShopClassifyService shopClassifyService;
    @Autowired
    StringRedisTemplate stringRedisTemplate;
    @Autowired
    private RedisTemplate<Object,Object> redisTemplate;

    @ApiOperation(value="商户分类列表", notes="返回所有分类")
    @RequestMapping(value = "/list",method = RequestMethod.POST)
    public Object list(ShopClassify shopClassify){
        Object userList = redisTemplate.opsForValue().get("shopClassify");//先从redis中获取，如果不存在则从数据库查询
        redisTemplate.opsForValue().set("shopClassify", shopClassifyService.findList(shopClassify));
        if(userList == null){
             userList = redisTemplate.opsForValue().get("shopClassify");
        }
        return redisTemplate.opsForValue().get("shopClassify");
    }

效果

输入localhost:port/swagger-ui.html,效果如下