举例说明springboot接口处写@ApiModelProperty注解

@ApiModelProperty注解可以用于控制Swagger文档生成规则，可以在实体类属性上使用。例如：

@ApiModel("用户实体类")
public class User {
    @ApiModelProperty(value = "用户ID", example = "1")
    private Integer id;
    @ApiModelProperty(value = "用户名", example = "John")
    private String username;
    @ApiModelProperty(value = "用户密码", example = "123456")
    private String password;
    // 省略getter/setter方法
}

@ApiModelProperty中的value属性可以设置该属性在Swagger文档中的描述信息，example属性可以设置该属性示例值，方便用户查看和测试。

相关问题

SpringBoot @ApiModelProperty注解

@ApiModelProperty注解是由Swagger提供的用于描述API接口中属性的注解，通常用于SpringBoot应用中。通过使用该注解，我们可以在生成的API文档中，清晰地展示出每个属性的含义、数据类型、是否必填等信息，使得API文档更加规范、易读。

例如，我们可以在一个DTO类的属性上添加@ApiModelProperty注解，如下所示：

public class UserDto {
    @ApiModelProperty(value = "用户ID", example = "123")
    private Long id;
    @ApiModelProperty(value = "用户名称", required = true, example = "张三")
    private String name;
    //...
}

其中，value属性用于描述属性的含义；example属性用于描述属性的示例值；required属性用于标识该属性是否必填。

suagger中@ApiModelProperty注解失效

在Swagger中，@ApiModelProperty注解用于给API文档中的模型属性添加描述信息。然而，根据引用中提到的问题，@ApiModelProperty注解不能修饰public修饰的类属性。这可能是导致@ApiModelProperty注解失效的原因之一。

为了解决这个问题，可以将属性的访问修饰符从public改为private。根据引用中的经验，将属性的修饰符改回private，可以恢复@ApiModelProperty注解的有效性。

需要注意的是，在Swagger中，@ApiModelProperty注解适用于非public修饰的属性。因此，如果想要使用@ApiModelProperty注解，并且确保其有效性，需要将属性的修饰符设置为非public。

总结来说，@ApiModelProperty注解失效的原因之一是其不能修饰public修饰的类属性。为了解决这个问题，可以将属性的修饰符改为private或其他非public修饰符。这样可以确保@ApiModelProperty注解在Swagger中起作用。<span class="em">1</span><span class="em">2</span><span class="em">3</span>