融资项目——swagger2的注解

1. @ApiModel与@ApiModelProperty(在实体类中使用)

融资项目——swagger2的注解_第1张图片

如上图,@ApiModel加在实体类上方,用于整体描述实体类。@ApiModelProperty(value="xxx",example="xxx")放于每个属性上方,用于对属性进行描述。swagger2网页上的效果如下图:

融资项目——swagger2的注解_第2张图片

2.@Api、@ApiOperation、@ApiParam(在Controller中使用)

融资项目——swagger2的注解_第3张图片

@Api使用方式如上图。其用于描述相应的Controller。效果如下:

融资项目——swagger2的注解_第4张图片

@ApiOperation(value="xxx",notes="xxx")使用方式如上图,notes是对于value更详细的说明,其用于描述相关的接口。效果如下:

@ApiParam使用方法如上图,value用于对参数进行描述,example给出测试默认值,required用于指出参数是否为必须接收的参数。其效果如下图所示:

你可能感兴趣的:(swagger2)