显示swagger接口文档

实体类:

最上层注解: @ApiModel("测试类")

每个对象上的注解:@ApiModelProperty(value = "对象说明", name = "对象变量名", required = false)

例:

@ApiModelProperty(value = "名字", name = "name", required = false)

private String name;

Rest接口类:

最上层注解: @Api(value = "测试接口", tags = {"测试接口"})

每个接口方法上的注解:

@ApiResponses({@ApiResponse(code = 200, message = "正常", response = EvaluationTaskQuestionnaire.class)})

@ApiOperation(value = "说明接口方法的作用")

 

每个参数前的注解: @ApiParam(name = "id", value = "入参值", required = false)

例:

@ApiResponses({@ApiResponse(code = 200, message = "正常", response = EvaluationTaskQuestionnaire.class)})

@ApiOperation(value = "验证进入接口方法")

public String abc(@ApiParam(name = "index", value = "任意整数", required = false)int index){

          int a = index;

          return "Hollow word";

}