休息响应中重复的 Swagger 鉴别器字段

Question

在 Rest 响应中，我的 swagger 文件中标记为“鉴别器”的字段被复制。我有一个父对象，它有一个名为“subjectType”的字段，我已将其标记为鉴别器。在我的休息调用中，我只返回资源对象（SubjectA 对象或 SubjectB 对象基于请求中的 subjectType），它具有以下 swagger 文件中提到的所有参数：

Subject:

type: object
discriminator: subjectType
properties:

  id:
    type: string
    minLength: 32
    maxLength: 32

  description:
    type: string
    maxLength: 350

  subjectType:
    type: string
    enum:
      - SubjectA
      - SubjectB

required:
  - subjectType
  - description

SubjectA:

allOf:

  - $ref: "#/definitions/Subject"
  - type: object
    properties:
      name:
        type: string
        maxLength: 100

      complexity:
        type: string
        maxLength: 256

    required:
    - name
    - complexity

SubjectB:

allOf:
  - $ref: "#/definitions/Subject"
  - type: object
    properties:
      prof:
        type: string
        maxLength: 100

      ref:
        type: string
        maxLength: 256

    required:
    - prof
    - ref

所以，当我返回 SubjectA 或 SubjectB 类型的响应对象时，我发回的响应对象只有一个“subjectType”字段，但实际的 json返回给客户端的响应有两个“subjectType”字段，我认为这是招摇的。 Swagger 版本：2.4.1

回复如下：

{ "subjectType" : "SubjectA", “id”：“123”， "subjectType" : "SubjectA", “名称”：“abc”， “复杂性”：“L1” }

@Path("/subjects")
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
@ResponseStatus(status = Response.Status.CREATED)
public Response createSubject(Subject subject) {

        //Removed my DAO calls and other logic.

        final Subject subject =
                createSubject(profile); //Modifying the subject object in this method as per my needs.
        return Response.status(Response.Status.CREATED).entity(subject).build();


}

以下是swagger codegen生成的对象：

@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-04-01T17:05:27.110-07:00")@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "subjectType", visible = true )
@JsonSubTypes({
@JsonSubTypes.Type(value = SubjectA.class, name = "SubjectA"),
@JsonSubTypes.Type(value = SubjectB.class, name = "SubjectB"),
})

public class Subject {

@JsonProperty("id")
private String id;

@JsonProperty("description")
private String description;

@JsonProperty("subjectType")
private String subjectType;

//Getters and Setters

}


@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-04-01T17:05:27.110-07:00")
public class SubjectA extends Subject {

@JsonProperty("name")
private String name;

@JsonProperty("complexity")
private String complexity;

//Getter and Setters


}

如何阻止 subjectType 字段在发送回客户端的 Json 响应中填充两次？

Answer 1

除了所涉及的开销之外，我不完全确定您的担忧是什么，在响应 JSON 中有重复的键。

JSON RFC，表示 JSON 对象：

对象中的名称应该是唯一的。

其中的应该是正式的defined as

这个词或形容词“推荐”的意思是 在特定情况下可能存在忽略 特定项目，但必须了解全部含义并 在选择不同的课程之前仔细权衡。

现在可能没有理由发生这种重复，但它并不被禁止，因此所有确认 JSON 工具都需要能够处理它。我本来希望 JSON 规范说明在存在非唯一键（例如第一个或最后一个值）的情况下选择什么值，但由于这些键的值是相同的，这并不重要。

这仍然是如何发生的问题。在许多语言中，JSON 对象的内部表示（例如 Python 中的 dict）是基于哈希的映射，甚至不能有重复的键。我假设这个 JSON 是以某种方式即时生成的，没有完整的内部表示，这会过滤掉重复项。