grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2824 opened on Jul 31, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
enhancementhelp wanted

Description

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.

Contributor guide

Tech stack
go
Domain
backendapideveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programminggRPC basicsCodebase navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.