Spring Boot集成 Swagger2

1、在pom文件中加入Swagger2 的 maven 依赖

        <!--swagger-->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <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>

2、使用 Swagger2 需要进行配置，新建一个配置类， Swagger2 的配置类上除了添加必要的 @Configuration 注解外，还需要添加 @EnableSwagger2 注 解。

package cn.bingo.config;

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;

/**
 * swagger配置
 * swagger-ui.html
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket customDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.bingo"))
                .paths(PathSelectors.any()).build();
    }

    // 创建api的基本信息
    private ApiInfo apiInfo(){
        Contact contact = new Contact("weibing",
                "https://www.cnblogs.com/zjk-main/",
                "1066406756@qq.com");
        return new ApiInfoBuilder()
                .title("项目API接口")
                .description("接口文档")
                .contact(contact)
                .version("1.1.0")
                .build();
    }
}

 

到此为止，我们已经配置 好了 Swagger2 了。现在我们可以测试一下配置有没有生效，启动项目，在浏览器中输入

localhost:8080/swagger - ui.html ，即可看到 swagger2 的接口页面，如下图所示，说明 Swagger2

集成成功。

 Controller 类中相关注解

package cn.bingo.controller;

import com.alibaba.fastjson.JSONObject;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;


@Api(value = "没什么用，可不配",tags = "TestController",description = "管理员操作")
@Controller
public class TestController {


    @ApiOperation(httpMethod = "POST",value = "管理员登录" ,produces = MediaType.TEXT_HTML_VALUE, notes = "根据id来获取用户详细信息")
    @RequestMapping("list")
    public JSONObject listInfo(){
        JSONObject result = new JSONObject();
        result.put("data", "success");
        return result;
    }
}

 

常用注解：

 @Api()用于类：用于类；表示标识这个类是swagger的资源
                           tags–表示说明
                           value–也是说明，可以使用tags替代

@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {

}

 @ApiOperation()：用于方法；表示一个http请求的操作
                                value用于方法描述
                                notes用于提示内容
                                tags可以重新分组（视情况而用）

 @ApiParam()：用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）
                            name–参数名
                            value–参数说明
                            required–是否必填

@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {
     @ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")
     @GetMapping("/getUserInfo")
     public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {
     // userService可忽略，是业务逻辑
      User user = userService.getUserInfo();

      return user;
  }
}

@ApiModel()：用于类 ；表示对类进行说明，用于参数用实体类接收
                           value–表示对象名
                           description–描述
                           都可省略
@ApiModelProperty()：用于方法，字段； 表示对model属性的说明或者数据操作更改
                                         value–字段说明
                                         name–重写属性名字
                                         dataType–重写属性类型
                                         required–是否必填
                                         example–举例说明
                                         hidden–隐藏

@ApiModel(value="user对象",description="用户对象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用户名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="状态",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;

      @ApiModelProperty(value="id数组",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

@ApiIgnore()：用于类或者方法上，可以不被swagger显示在页面上，比较简单, 这里不做举例

@ApiImplicitParam() ：用于方法，表示单独的请求参数

@ApiImplicitParams()： 用于方法，包含多个 @ApiImplicitParam
                                          name–参数ming
                                          value–参数说明
                                          dataType–数据类型
                                          paramType–参数类型
                                          example–举例说明

  @ApiOperation("查询测试")
  @GetMapping("select")
  //@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query")
  @ApiImplicitParams({
  @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),
  @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})
  public void select(){

  }