springboot整合swagger的基本使用

前言

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。本文简单介绍了在项目中集成swagger的方法和一些常见问题。

1.引入maven依赖

        <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的配置类

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {

    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否启动swagger
                .enable(true)
                .select()
                //RequestHandlerSelectors:配置要扫描接口的方式
                //basePackage:指定要扫描的包
                //any:扫描全部
                //none：不扫描
                //withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象
                //withMethodAnnotation：扫描方法上的注解
               .apis(RequestHandlerSelectors.basePackage("com.sise.controller"))
                //paths:过滤什么路径
                .paths(PathSelectors.ant("/com/sise/pass/**"))
                .build();
    }




    //配置swagger的信息
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact=new Contact("dessw","https:/xxxx.com/","1335162133@qq.com");

        return new ApiInfo(
                "SwaggerApi文档标题",
                "SwaggerApi文档描述",
                "v1.0",
                "https:/blog.kuangstudy.com/",
                contact,
                "Apache 2.0",
                "http://www.apche.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
    
}

3.测试

访问:http://localhost:8080/swagger-ui.html
能够看到如下页面，说明已经配置成功了

4.swagger基本注解

@Api注解可以用来标记当前Controller的功能。其中tags表示说明
value也是说明，可以使用tags替代

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

效果图：

@ApiOperation注解用来标记一个方法的作用。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(){ }

参考链接