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

Question

I have a Student class and I need id , name , email , dob , age parameters. These parameters are shown on swagger as below.

I do not want id appear on the swagger documentation. How can I do that?

I have tried

• @Schema(hidden = true)
• @Parameter(hidden = true) But didn't worked

I want to see only below parameters on swagger

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

Can anyone help me about that, please?

Answer 1

For me, ApiModelProperty and ApiParam didn't exist. I found the solution on documentation . The solution is as below;

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

Also thanks to @Waled Ahmad