[OpenAPI 3.1] Phase 1: 3.0→3.1 converter

未关闭
#949 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 5 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
38/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
java, openapi
领域
tooling

调研方向

Start from the plan in #942, then look at how org.openapitools.openapidiff.core currently parses specs and where swagger-core's mapper and JsonSchema are already used. The new normalize package must walk components, parameters, headers, bodies, callbacks and nested schemas, applying the listed rules on a deep copy. Compare converted 3.0 output against natively parsed 3.1 for the paired fixtures under the test resources as serialized JSON; also add the Swagger 2.0 fixture and a test asserting the input objects are unchanged.

由索引模型根据 Issue 内容生成。

描述

OpenAPI 3.1.0 Support

Part of the OpenAPI 3.1 plan: #942 (Stage 1, Phase 1)

Goal

A converter that turns Swagger 2.0 / OpenAPI 3.0 objects into the 3.1 form. Not wired in yet.

Scope
  • New package org.openapitools.openapidiff.core.normalize, called once per spec
  • Walks every schema: components, parameters, headers, request/response bodies, callbacks, and nested (properties, items, additionalProperties, allOf/anyOf/oneOf, not)
  • Rules: type → types; nullable: true → "null" in types (not when there is no type); boolean exclusiveMinimum/Maximum → numeric; example → examples; typed classes → JsonSchema
  • Works on a copy (JSON round-trip with swagger-core's mapper), so the input objects are never modified
Done when
  • Converted 3.0 == natively parsed 3.1 (compared as serialized JSON) for all paired fixtures
  • Swagger 2.0 fixture converts correctly
  • Copy test: input objects are unchanged after conversion
主要语言
Java
星标
1.1k
派生
191
平均合并
4 天 23 小时
30 天内合并 PR
1

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

OpenAPITools/openapi-diff 的其他 Issue

查看 OpenAPITools/openapi-diff 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。