之前项目是swagger2,使用@ApiModelProperty注解,接口完成后,使用uoload 可以直接上传,文档中该有的字段注释都有,现在使用swagger3了
,用的 @Schema注解标注字段,生成文档后没有字段注释信息了,是需要怎么设置吗
在 IDEA 中使用 APIFox 插件生成文档时,如果原来在 Swagger2 中使用的 @ApiModelProperty 注解不再起作用,可以尝试使用 Swagger3 中的 @Parameter 和 @Schema 注解来标注字段。
具体操作步骤如下:
@GetMapping("/users")
public List<User> getUsers(
@Parameter(description = "Page number, starting from 0")
@RequestParam Integer page,
@Parameter(description = "Page size, maximum 100")
@RequestParam(defaultValue = "20") Integer size) {
...
}
public class User {
@Schema(description = "User ID")
private Long id;
@Schema(description = "User name")
private String name;
@Schema(description = "User age")
private Integer age;
...
}
用对象接收参数时,描述对象的一个字段