Swagger 2 如何僅從請求示例中排除屬性

Question

使用 DTO 執行與服務器的交互。 我使用 swagger 來記錄 API，但我有一個問題。 在 DTO 中，我有在服務器上設置的字段，即 API 客戶端不必填寫它們（例如，id 和 creationDate）。 但是如果你使用 swagger，它會在示例中顯示這些字段，這可能會使用戶感到困惑。 我嘗試將以下注釋添加到 DTO 屬性：

    @ApiModelProperty(hidden = true)
    private Long id;

但在這種情況下，這些字段也會從服務器響應示例中消失。 如何確保這些屬性僅在響應中可見，即僅在示例請求中隱藏？

Answer 1

您可以使用@ApiModelProperty(readOnly = true)實現相同的目的。
允許將 model 屬性指定為只讀。 它將隱藏請求中的屬性並僅顯示響應。

@ApiModelProperty(readOnly = true)
private Long id;