Introduce check concept from "Azure/openapi-diff" project
维护者通常 5 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- openapi
- 领域
- api
调研方向
首先阅读 Azure/openapi-diff 文档及其 openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger 测试,然后将它们报告的检查项与本项目当前的比较行为进行对比。该 issue 未指明本地文件或入口点;要完成此项工作,需要商定集成范围及相应的检查项。
由索引模型根据 Issue 内容生成。
描述
The project Azure/openapi-diff produce following output when two versions of a spec are compared: a list of items (error, warning, info) is computed.
Example:
$ oad compare old/added_path.json new/added_path.json
{
"id": "1001",
"code": "NoVersionChange",
"message": "The versions have not changed.",
"jsonref": "#",
"json-path": "#",
"type": "Info"
}
{
"id": "1039",
"code": "AddedOperation",
"message": "The new version is adding an operation that was not found in the old version.",
"jsonref": "#/paths/~1api~1Operations/post",
"json-path": "#/paths/api/Operations/post",
"type": "Info"
}
{
"id": "1038",
"code": "AddedPath",
"message": "The new version is adding a path that was not found in the old version.",
"jsonref": "#/paths/~1api~1Paths",
"json-path": "#/paths/api/Paths",
"type": "Info"
}
The list of rules that are currently checked can be found in their git repository: docs
I had a look at their test suite in this folder: Swagger
To run their the oad tool against it, I had to perform some changes: https://github.com/Azure/openapi-diff/pull/108
Then I have converted the old Swagger 2.0 format to OpenAPI 3.0.1 format.
Of course, I will share my work.
We can then continue the discussion and see how this could be integrated.
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 191
- 平均合并
- 4 天 23 小时
- 30 天内合并 PR
- 1
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
OpenAPITools/openapi-diff 的其他 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 68/100
OpenAPITools/openapi-diff#506 ·
维护者通常 5 天内回复
-
HtmlRender: Notes of Parameters shows always the new description可能已有人在做 @Inf1mum 于 6 天前认领。 未关闭good first issue help wanted
难度 2/5 1-3 小时 新手友好度 68/100
OpenAPITools/openapi-diff#364 ·
维护者通常 5 天内回复
-
Render capabilities
难度 5/5 一周以上 新手友好度 20/100
OpenAPITools/openapi-diff#959 ·
维护者通常 5 天内回复
-
Render capabilities
难度 5/5 一周以上 新手友好度 18/100
OpenAPITools/openapi-diff#958 ·
维护者通常 5 天内回复
-
Render capabilities
难度 3/5 1-2 天 新手友好度 55/100
OpenAPITools/openapi-diff#957 ·
维护者通常 5 天内回复
查看 OpenAPITools/openapi-diff 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
eclipse-tradista/tradista#371 ·
维护者通常 1 天内回复
-
critical
难度 2/5 1-3 小时 新手友好度 68/100
mars-sim/mars-sim#2199 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
primefaces/primefaces#15568 ·
维护者通常 1 天内回复
-
崩溃日志只按 CRLF 分行未关闭
难度 2/5 1-3 小时 新手友好度 72/100
PCL-Community/PCL-CE#3872 ·
维护者通常 1 天内回复