grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2824 aperta il 31 lug 2022

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

Metriche repository

Star
 (16.971 star)
Metriche merge PR
 (Merge medio 1g 4h) (141 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 esaminando il parser httprule in internal/httprule e il parser OpenAPI in protoc gen openapiv2/internal/genopenapi. Comprendi come ciascun parser legge i modelli di percorso e genera le route. Cerca eventuali test esistenti nel pacchetto httprule. Quindi identifica i passaggi per sostituire il parser genopenapi con httprule, garantendo un comportamento coerente. Controlla se ci sono discussioni in corso o PR collegate per orientamento.
Tech stack
go
Dominio
backendapideveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go programminggRPC basicsCodebase navigation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40