java - 开放API 3.0.1只读注解

Question

我在使用 Open API 3.0.1 java 注释将特定方法的属性定义为 readOnly 时遇到一些问题。在 POST 操作期间，API 需要一个 NewAccount 模型。这是模型的截断表示；

{
    "user": {
        "id": "...",
        ...
    },
    "account": {
        "id": "...",
        ...
    }
}

我需要的是在此操作中将user.id和account.id定义为readOnly。我的所有文档都是通过注释从代码生成的，这就是我到目前为止所拥有的；

    @POST
    @Path("/access/accounts")
    @Consumes("application/json")
    @Operation(
            summary = "Create a new account.",
            description = "Create a new account."
    )
    @Tags({@Tag(name = "account")})
    @RequestBody(
            description = "New accounts required models.",
            required = true,
            content = @Content(
                    schema = @Schema(
                            implementation = NewAccount.class
                    )
            )
    )
    @ApiResponses({
            @ApiResponse(
                    responseCode = "201",
                    description = "The new account.",
                    content = @Content(
                            schema = @Schema(
                                    implementation = Account.class
                            )
                    )
            )
    })

Answer 1

您需要将 @Schema(accessMode = Schema.AccessMode.READ_ONLY) 注释添加到 id 属性。这将在生成的 OpenAPI 定义中将 id 属性标记为 readOnly: true。

示例 from here :

import io.swagger.v3.oas.annotations.media.Schema;

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