如何在 Swagger API 中隐藏请求字段

Question

我想在模型中隐藏“id”项，在java中怎么做？

Answer 1

在 Swagger API v2 中隐藏请求字段：

 @ApiModelProperty(hidden = true) 
 private String id;

在 OpenAPI v3 中：

@Schema(accessMode = Schema.AccessMode.READ_ONLY)
private String id;

Answer 2

@JsonProperty(access = JsonProperty.Access.READ_ONLY)
@ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY)
private String id;

另见：https://github.com/springfox/springfox/issues/2816

Answer 3

您可以将@Hidden 与Swagger Core 2.X 一起使用

@Hidden -- 隐藏资源、操作或属性

来自上述链接的示例：将给定的资源、类或 bean 类型标记为隐藏，在读取/解析时跳过。

@Path("/user")
@Produces({"application/json", "application/xml"})
public class HiddenAnnotatedUserResourceMethodAndData {
    UserData userData = new UserData();

    @POST
    @Hidden
    @Operation(summary = "Create user",
            description = "This can only be done by the logged in user.")
    @Path("/1")
    public Response createUser(
            @Parameter(description = "Created user object", required = true) User user) {
        userData.addUser(user);
        return Response.ok().entity("").build();
    }

    @POST
    @Operation(summary = "Create user",
            description = "This can only be done by the logged in user.")
    @Path("/2")
    public Response createUserWithHiddenBeanProperty(
            @Parameter(description = "Created user object", required = true) UserResourceBean user) {
        return Response.ok().entity("").build();
    }
}

上面的输出

openapi: 3.0.1
paths:
  /user/2:
    post:
      summary: Create user
      description: This can only be done by the logged in user.
      operationId: createUserWithHiddenBeanProperty
      requestBody:
        description: Created user object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/UserResourceBean'
        required: true
      responses:
        default:
          description: default response
components:
  schemas:
    UserResourceBean:
      type: object
      properties:
        foo:
          type: string