OpenAPI多态与Discriminator治理

概览

  • 多态通过 `oneOf` 与 `discriminator` 表达;生成器据此选择具体类型;需治理命名与兼容。

技术参数(已验证)

  • `oneOf`:列出候选模式;使用 `discriminator.propertyName` 指定区分字段;`mapping` 映射值到模式。
  • 兼容:新增类型不破坏旧客户端;避免移除或重命名;在文档中维护映射与示例。
  • 生成器:验证支持;保持 `$ref` 与命名一致;在代码生成中提供类型安全。
  • 校验:在 CI 中对示例与真实响应进行校验;阻断不兼容变更。
  • 可读性:保持区分字段语义清晰;避免过度嵌套与复杂性。

实战清单

  • 为多态资源定义清晰区分字段与映射;提供示例与测试。
  • 在契约演进中新增类型并保持兼容;记录变化。
  • 将生成与校验纳入流水线;确保一致。


点赞(0) 打赏

评论列表 共有 0 条评论

暂无评论
立即
投稿

微信公众账号

微信扫一扫加关注

发表
评论
返回
顶部