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 天內回覆