idea中的apifox插件使用问题

Question

之前项目是swagger2，使用@ApiModelProperty注解，接口完成后，使用uoload 可以直接上传，文档中该有的字段注释都有，现在使用swagger3了
，用的 @Schema注解标注字段，生成文档后没有字段注释信息了，是需要怎么设置吗

Answer 1

在 IDEA 中使用 APIFox 插件生成文档时，如果原来在 Swagger2 中使用的 @ApiModelProperty 注解不再起作用，可以尝试使用 Swagger3 中的 @Parameter 和 @Schema 注解来标注字段。

具体操作步骤如下：

• 首先，在代码中使用 @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;
  
  ...
}

• 然后，在 IDEA 的 APIFox 插件界面中，选择要导出文档的项目和模块，并设置相应的参数。
• 在导出文档之前，需要在插件设置中勾选 “Enable Schema Description” 选项，这样才能够将 @Schema 注解中的字段描述导出到文档中。
• 导出文档后，在文档中查看对应的接口，应该能够看到 @Parameter 和 @Schema 注解中的字段描述信息。
  需要注意的是，APIFox 插件的导出功能可能会受到版本限制和其他因素的影响，如果无法正常导出字段描述信息，可以尝试升级插件版本或者寻找其他替代方案。