[Rendering] R3: new Render API and migration notes

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

维护者通常 5 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
java
领域
tooling

调研方向

Read the rendering plan in #954 first, then find the current Render entry point and the renderer classes that take ChangedOpenApi/Changed* so you know what is being removed. The migration notes and README output examples depend on the final Render.render(ChangeReport, Writer) signature and the --json, --html-detailed, --template and stderr-logging behaviour, so settle the API before writing docs. Done means no renderer references Changed* classes and the README plus migration notes match the new CLI output.

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

描述

Render capabilities

Part of the rendering plan: #954 (R3)

Goal

The stable 3.0.0 rendering API; old renderer code is removed.

Scope
  • Render.render(ChangeReport, Writer); the caller owns and closes the writer
  • Remove the old renderer code and the deprecated String render(ChangedOpenApi)
  • Migration notes: Render API, --json format, --html-detailed, --template, logs on stderr
  • README: output examples for every format and a template example
Done when
  • No renderer reads Changed* classes or spec objects
  • Migration notes and README updated
主要语言
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 摘要。