Swagger-core: Swagger는 openapi.yaml을 생성할 때 기본이 아닌 유형에서 @Schema(required = true)를 무시합니다.

openapi.yaml 사양을 생성할 때 Swagger가 개체 필드의 @Schema(required = true) 주석을 무시하는 재현 가능한 문제가 있습니다.

이를 재현하려면 일반 단계를 따르십시오.
1) 2.0에서 swagger-samples 저장소를 복제합니다(https://github.com/swagger-api/swagger-samples/tree/2.0).
2) Swagger 2.0.8(비스냅샷)을 사용하도록 루트 pom.xml을 변경합니다.
3) java-jersey2-minimal로 이동합니다.
4) Pet 개체 아래에서 코드를 다음과 같이 수정합니다.

  @XmlElement(name = "id")
  @Schema(required = true)
  public long getId() {
    return id;
  }

  public void setId(long id) {
    this.id = id;
  }

  @XmlElement(name = "category")
  @Schema(required = true)
  public Category getCategory() {
    return category;
  }

(여기서 "id" 및 "category" 필드 모두에 @Schema(required = true) 필수 태그를 추가합니다.)

5) 설명된 대로 샘플을 빌드하고(https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-jersey2-minimal) yaml을 생성합니다.

이 단계를 수행한 후 생성된 yaml에 다음이 포함되어 있음을 알 수 있습니다.

...
Pet:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          format: int64
        category:
          $ref: '#/components/schemas/Category'
...

이것은 예상치 못한 일입니다. 내가 추가하는 것을 기대 @Schema(required = true) 로 id 및 category 필드를 모두 추가 할 수 id 및 category 의 "요구"섹션 애완 동물 얌. 그러나 id 추가된 것을 볼 수 있습니다. 다른 시나리오에서 이것을 테스트했으며 OpenApi 프리미티브(즉, $ref가 없는 경우)인 경우에만 필드를 "필수"로 추가하는 것 같습니다.

category 를 "필수" 섹션에 수동으로 추가하면 Swagger UI에 category 가 필요하다는 것이 올바르게 표시됩니다. 그러나 수동으로 추가하지 않으면 category 에 다른 필수 필드와 동일한 빨간색 별표가 표시되지 않습니다.

이 문제로 인해 복잡한 유형의 개체가 API 요청에서 채워져야 하고 생략될 수 있는 개체를 지정하기가 더 어렵습니다. 이것은 Immutables를 사용할 때 특히 유용합니다. Immutables의 일부 필드는 아무 것도 지정되지 않은 경우 기본값을 사용하고 다른 필드의 경우 immutables는 누락된 경우 예외를 throw하기 때문입니다.