SwaggerUI日常使用

　　最近公司项目集成springFox，记录一些swaggerUI日常使用，包括数组，文件，默认值，允许值，参数/结果类注解，响应码..等等。

 　　一.参数注解：

　　单参数：@ApiImplicitParam

　　多参数：@ApiImplicitParams

@ApiImplicitParams({
            @ApiImplicitParam(name = "pageIndex",value = "页码,默认值：0",dataType = "int",
                    paramType = "query"),
            @ApiImplicitParam(name = "pageSize",value = "页长,默认值：20",dataType = "int",
                    paramType = "query")
    })

　　可以看一下参数注解接口相关属性如下：

public @interface ApiImplicitParam {
    //参数名
    String name() default "";
    //参数作用，对应中文名
    String value() default "";
    //默认值
    String defaultValue() default "";
    //允许值的范围，逗号分隔
    String allowableValues() default "";
    //是否必传，可以看到默认是非必填的
    boolean required() default false;
    //暂时没用到
    String access() default "";
    //是否允许数组
    boolean allowMultiple() default false;
    //参数类型：int/String之类的，注：不支持integer
    String dataType() default "";
    //参数作用类型：比如query正常查询参数，path表示路径参数
    String paramType() default "";
    //举例
    String example() default "";

    Example examples() default @Example({@ExampleProperty(
    mediaType = "",
    value = ""
)}); 

　　下面详细介绍下几种应用：

　　1.文件类型：

@ApiImplicitParam(name = "file",value = "文件",dataType = "file",paramType = "query")

　　2.数组，以string数组为例

@ApiImplicitParam(name = "type",value = "类型",dataType = "String",  paramType = "query",allowMultiple = true),

　　3.默认值

 @ApiImplicitParam(name = "type",value = "类型",dataType = "String",paramType = "query",defaultValue = "test"),

　　4.允许值，比如状态，开关类字段，一般只支持0/1

@ApiImplicitParam(name = "status",value = "状态",dataType = "int",paramType = "query",allowableValues = "0,1"),

       5.参数/结果类注解 一般常用@requestbody封装的参数类，或者设定的结果类。

public void create(@ApiParam @RequestBody Entity entity)

　　然后在对应的参数类中添加响应的@apimodel和@apiproperty注解   

@ApiModel
public class Entity {
    @ApiModelProperty(name = "id",value = "主键")
    private int id;                                     

    @ApiModelProperty(name = "type",value = "类型",)
    private String type;                                
}

　　6.响应码

@ApiResponses({
            @ApiResponse(code = 200,message = "操作成功"），
                    
    })

　　在swaggerui界面的model中可以看到生成效果，这里我只加了前两个注解　　

　　7.必填项，默认非必填。注：必填项一定要和接口设定一致。　

@ApiImplicitParam(name = "id",value = "id",dataType = "String", paramType = "query",required = true)

　　8.路径参数，比如接口路径为 /type/{id}，可以如下定义注解　

@ApiImplicitParam(name = "id",value = "id",dataType = "String", paramType = "path",required = true)

 

 

待补充...