grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Aperta

#2824 aperta il 31 lug 2022

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Go (2250 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (16.971 stelle)
Metriche merge PR
 (Merge medio 8g 23h) (147 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Inizia comprendendo il pacchetto httprule in internal/httprule e come viene utilizzato in protoc gen grpc gateway. Quindi esamina il pacchetto genopenapi per vedere come vengono analizzati i template dei percorsi. Identifica le differenze e pianifica un refactoring per sostituire il parser genopenapi con httprule. Assicurati che i test siano superati e che entrambi i generatori producano percorsi coerenti.
Tech stack
go
Dominio
backendapitooling
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GogRPCprotobuf
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
55