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.