swgger2简单配置类以及常用注解

swgger2配置类

public class Swagger2Config {

    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(""))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("基础数据API说明文档")
                .description("2019.7.18上线版本")
                .contact("部门")
                .version("版本")
                .build();
    }
}

swgger2常用注解

1.@Api()
用于类；表示标识这个类是swagger的资源
tags–表示说明
value–也是说明，可以使用tags替代
但是tags如果有多个值，会生成多个list

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

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

4.@ApiModelProperty()
用于方法，字段； 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

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

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

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