如何从 swagger spring boot 中隐藏一些参数？

Question

我有一个 Student 类，我需要id 、 name 、 email 、 dob 、 age参数。 这些参数显示在 swagger 上，如下所示。

我不希望 id 出现在 swagger 文档中。 我怎样才能做到这一点？

我试过了

• @Schema（隐藏=真）
• @Parameter(hidden = true) 但没用

我只想在 swagger 上看到以下参数

{
  "name": "string",
  "email": "string",
  "dob": "2022-12-19",
  "age": 0
}

有人可以帮我吗？

Answer 1

对我来说，ApiModelProperty 和 ApiParam 不存在。 我在文档中找到了解决方案。 解决方法如下；

public class Student {
     @Schema(accessMode = Schema.AccessMode.READ_ONLY)
     private Long id;
}

也感谢@Waled Ahmad