grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2,824 创建于 2022年7月31日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Go (16,971 star) (2,250 fork)batch import
enhancementhelp wanted

描述

We have at least two parsers for the http.proto template language;

  • In the httprule package, which is used by protoc-gen-grpc-gateway to generate the handler paths
  • In the genopenapi package to generate the OpenAPI paths.

We should unify these two places, and we should be using the one in httprule. I did a little bit of investigating and I think it should be possible without too much work, and then we'd have consistency between the two generators.

贡献者指南

技术栈
go
领域
backendapideveloper experience
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Go programminggRPC basicsCodebase navigation
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Start by examining the httprule parser in internal/httprule and the OpenAPI parser in protoc gen openapiv2/internal/genopenapi. Understand how each parser reads path templates and generates routes. Look for any existing tests in the httprule package. Then identify the steps to replace the genopenapi parser with httprule, ensuring consistent behavior. Check if there are any ongoing discussions or linked PRs for guidance.