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.