OpenAPITools/openapi-diff

Version identifiers in paths

Open

#253 建立於 2021年7月28日

在 GitHub 查看
 (3 留言) (1 反應) (0 負責人)Java (1,079 star) (187 fork)user submission
enhancementhelp wanted

描述

The specs I want to compare have a version identifier in their paths:

E.g. api/v1/users and api/v2/users

Comparing these specs triggers false positives because of the paths, even when the rest of the specs are identical.

As a workaround I'm manipulating the specs before comparing - manually replacing api/v*/users with api/users in both.

Is there a way built into the tool that could solve my problem?

Or would it perhaps make sense to implement some kind of wildcard support?

Great project!

貢獻者指南

技術棧
javarest api
領域
backendapitooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaOpenAPI specificationbasic knowledge of diff algorithms
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
Investigate the existing path comparison logic in the OpenAPI diff tool, likely in Java source files under src/main/java. Implement a wildcard matching strategy to ignore version segments in paths (e.g., replace /api/v{version}/ with a common pattern). Consider using regex or path templates to generalize the comparison. Check comments in this issue for additional context or suggestions.