Inheritance support
维护者通常 2 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
调研方向
在 playground 中使用 spring 2021.5,并在本地使用 2023.1.2,复现 issue 中的最小 OpenAPI 示例。将生成的 ParentSchema 和 ChildSchema 输出与预期的独立类层次结构进行比较,然后确定是否有意支持继承,以及应记录或更改哪种行为。
由索引模型根据 Issue 内容生成。
描述
Quite impressed with the toolset you created here.
I was curious about inheritance support so I tried it out with a minimal example:
openapi: 3.0.2
info:
title: edit me
version: 1.0.0
paths:
/nothing:
description: dummy
get:
responses:
'200':
description: empty
content:
'application/json':
schema:
$ref: '#/components/schemas/ChildSchema'
components:
schemas:
ParentSchema:
type: object
properties:
parentAttr:
type: string
ChildSchema:
allOf:
- $ref: '#/components/schemas/ParentSchema'
- type: object
properties:
childAttr:
type: string
This yields a ChildSchema.java consisting of everything from the parent and child model:
public class ChildSchema {
@JsonProperty("parentAttr")
private String parentAttr;
@JsonProperty("childAttr")
private String childAttr;
public String getParentAttr() {
return parentAttr;
}
public void setParentAttr(String parentAttr) {
this.parentAttr = parentAttr;
}
public String getChildAttr() {
return childAttr;
}
public void setChildAttr(String childAttr) {
this.childAttr = childAttr;
}
}
Now specifying a discriminator results in inheritance in the generated code (at least for the openapi-generator project):
openapi: 3.0.2
info:
title: edit me
version: 1.0.0
paths:
/nothing:
description: dummy
get:
responses:
'200':
description: empty
content:
'application/json':
schema:
$ref: '#/components/schemas/ChildSchema'
components:
schemas:
ParentSchema:
type: object
discriminator:
propertyName: className
properties:
parentAttr:
type: string
ChildSchema:
allOf:
- $ref: '#/components/schemas/ParentSchema'
- type: object
properties:
childAttr:
type: string
For this a special propertyName of className is used. If I run that in your playground with spring 2021.5 it complains about the property name which is not wrong strictly speaking:
The discriminator 'className' is not a property of this schema (code: 134)
If I run this locally with 2023.1.2 then this does not error but does not generate two classes with one inheriting from each other:
public class ChildSchema {
@JsonProperty("parentAttr")
private String parentAttr;
@JsonProperty("childAttr")
private String childAttr;
public String getParentAttr() {
return parentAttr;
}
public void setParentAttr(String parentAttr) {
this.parentAttr = parentAttr;
}
public String getChildAttr() {
return childAttr;
}
public void setChildAttr(String childAttr) {
this.childAttr = childAttr;
}
}
Expected result would have been:
public class ParentSchema {
@JsonProperty("parentAttr")
private String parentAttr;
public String getParentAttr() {
return parentAttr;
}
public void setParentAttr(String parentAttr) {
this.parentAttr = parentAttr;
}
}
public class ChildSchema extends ParentSchema {
@JsonProperty("childAttr")
private String childAttr;
public String getChildAttr() {
return childAttr;
}
public void setChildAttr(String childAttr) {
this.childAttr = childAttr;
}
}
Now this expectation could of course be wrong. My question now would be if this inheritance use case is supported and/or if I would have to do something differently to get the desired result. Thanks.
- 主要语言
- Kotlin
- 星标
- 56
- 派生
- 11
- 平均合并
- 4 天 10 小时
- 30 天内合并 PR
- 8
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
openapi-processor/openapi-processor-spring 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
openapi-processor/openapi-processor-spring#524 ·
维护者通常 2 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
openapi-processor/openapi-processor-spring#334 · 2 条评论 ·
维护者通常 2 天内回复
-
enhancement
难度 3/5 1-2 天 新手友好度 42/100
openapi-processor/openapi-processor-spring#150 · 3 条评论 ·
维护者通常 2 天内回复
-
undecided
难度 5/5 一周以上 新手友好度 25/100
openapi-processor/openapi-processor-spring#101 · 1 条评论 ·
维护者通常 2 天内回复
-
enhancement undecided
难度 3/5 1-2 天 新手友好度 35/100
openapi-processor/openapi-processor-spring#51 ·
维护者通常 2 天内回复
查看 openapi-processor/openapi-processor-spring 的全部 Issue
相似的 Issue
-
help wanted needs investigation priority: low
难度 2/5 1-3 小时 新手友好度 62/100
-
bug
难度 2/5 1-3 小时 新手友好度 62/100
LeanBitLab/LeanType#883 ·
维护者通常 1 天内回复
-
Heavy legs 1.12–1.17: compiler corpus goldens not regenerated for #4770可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 74/100
intellij-elixir/intellij-elixir#4782 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
komikku-app/komikku#1983 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 62/100
Seb3thehacker/gearslip#121 ·