SpringBoot项目集成Swagger2

1、导入Swagger依赖

<!--        添加Swagger2的依赖-->
<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>

2、定义Swagger配置类

package com.zhao.config;

import io.swagger.annotations.ApiOperation;
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.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
//使Swagger生效
@EnableSwagger2
public class SwaggerConfig {
    //将Docket组件添加到容器中
    @Bean
    public Docket createRestApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);

        // ApiInfoBuilder 用于在Swagger界面上添加各种信息
        ApiInfoBuilder builder = new ApiInfoBuilder();
        builder.title("填写项目名称");
        ApiInfo apiInfo = builder.build();
        docket.apiInfo(apiInfo);

        // ApiSelectorBuilder 用来设置哪些类中的方法会生成到REST API中
        ApiSelectorBuilder selectorBuilder = docket.select();
        selectorBuilder.paths(PathSelectors.any()); //所有包下的类
        //使用@ApiOperation的方法会被提取到REST API中
        selectorBuilder.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));
        docket = selectorBuilder.build();
        return docket;
    }
}

selectorBuilder.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));这句非常重要，要认真理解。

3、测试Swagger代码

package com.zhao.controler;

import com.zhao.common.util.R;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

//定义指定，返回的是Json数据
@RestController
//定义 访问的相对路径
@RequestMapping("/swagger")
@Api("Swagger的测试类")
public class SwaggerTestController {

    //定义方法的  访问相对路径
    @GetMapping("/test")
    //APIOperation的注解是在配置Swagger的时候定义的，作用是：当添加了这个注解的方法会被Swagger扫描到，上图41行
    @ApiOperation("Swagger接口的测试方法带的注解")
    public R swaggerTest(){
        return R.ok("Swagger接口，接通了");
    }
}

在此声明，我返回的R对象的结构：

package com.zhao.common.util;

import org.apache.http.HttpStatus;

import java.util.HashMap;
import java.util.Map;

/**
 * @Author: 
 * @Date: 
 * @Description: 封装Web返回对象
 */
public class R extends HashMap<String, Object> {

    public R() {
        //定义状态码为200
        put("code", HttpStatus.SC_OK);
        //定义消息为成功
        put("msg", "success");
    }
    // 重写父类HashMap的put方法，实现链式调用put方法
    public R put(String key, Object value) {
        super.put(key, value);//这里调用的是父类HashMap的put方法
        return this;
    }
    //定义常用Web数据返回类型
    public static R ok() {
        //此时返回的R对象包括code和msg
        return new R();
    }
    //自定义消息信息(通过传入的参数）
    public static R ok(String msg) {
        R r = new R();
        r.put("msg", msg);
        return r;
    }
    //向对象中传入map集合
    public static R ok(Map<String, Object> map) {
        R r = new R();
        r.putAll(map);
        return r;
    }
    public static R error(int code, String msg) {
        R r = new R();
        r.put("code", code);
        r.put("msg", msg);
        return r;
    }
    // 此时返回的错误为500错误， 但是错误信息可以自己定义
    public static R error(String msg){
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
    }
    // 500异常，且不知道什么错误，直接返回error
    public static R error() {
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "抱歉，这是未知异常，请联系管理员！");
    }

}

4、测试结果

在浏览器中输入
http://127.0.0.1:8080/swagger-ui.html
或者， http://localhost:8080/swagger-ui.html

这个html在

a. 首页面：

b. 点击执行按钮（Try it out）

c. 点击执行（Execute）

d. 测试结果：

如果有疑问，可以在评论区提出，我们共同交流，共同个进步。

如果有帮助，点个关注，共同进步。