apifox无法识别notNull标记

Question

apifox生成文档时，不能识别到@Notnull 和@NotBlank标签，仍显示为可选

如果：引用了校验标注

生成的接口文档如图

Answer 1

引自免费微信小程序：皆我百晓生

在Apifox中，如果要识别Java代码中的@NotNull和@NotEmpty等JSR 303/JSR 349 Bean Validation注解，并在生成的接口文档中标记为必填项，你需要确保Apifox正确解析了这些注解。以下是排查和解决这个问题的步骤：

1. 确认导入的校验库是否被Apifox支持： Apifox需要能够识别你使用的校验注解库，根据你的代码，你使用的是javax.validation.constraints.NotEmpty和javax.validation.constraints.NotNull，这两个注解是标准的Bean Validation注解，理论上Apifox应该能识别。

2. 配置Apifox项目设置： 在Apifox中，检查该项目的设置，确保已开启对Bean Validation注解的支持。在Apifox项目的详细信息页面或相关配置界面中找到并勾选“启用Java方法参数验证”等相关选项。

3. 重新导入或更新API定义： 确保Apifox获取到了最新的、包含校验注解的Java类定义。如果是通过源码的方式导入，请重新导入；如果是通过Swagger/OpenAPI或者Javadoc方式生成的，那么请更新相关的API定义文件。

4. 检查代码结构： 确保@Validated注解应用在Controller层方法的请求体参数上，如你提供的代码所示：

   public Result<Void> uploadGoodsMsg(@Validated @RequestBody UploadGoodsMsgParams params) { ... }
   

   这样才能触发参数的校验及Apifox的识别。

5. 查看Apifox生成的文档： 如果以上步骤都正确无误，但在Apifox生成的接口文档中仍然显示为可选，那可能是Apifox的一个潜在bug或者是解析逻辑的问题。这种情况下，建议反馈给Apifox官方社区或客服，提供具体案例以便他们修复问题。

总之，按照上述步骤逐一排查后，理论上Apifox应当能够识别并展示出@NotNull和@NotEmpty标注的字段为必填项。如果问题依旧存在，请及时与Apifox团队联系以寻求技术支持。