grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2,824 opened on Jul 31, 2022

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

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

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

Research direction
Start by understanding the httprule package in internal/httprule and how it is used in protoc gen grpc gateway. Then examine the genopenapi package to see how path templates are parsed. Identify differences and plan a refactoring to replace the genopenapi parser with httprule. Ensure tests pass and both generators produce consistent paths.
Tech stack
go
Domain
backendapitooling
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GogRPCprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55