grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2.824 geöffnet am 31. Juli 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (2.250 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (16.971 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 4h) (141 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Beginnen Sie mit der Untersuchung des httprule Parsers in internal/httprule und des OpenAPI Parsers in protoc gen openapiv2/internal/genopenapi. Verstehen Sie, wie jeder Parser Pfadvorlagen liest und Routen generiert. Suchen Sie nach vorhandenen Tests im httprule Paket. Identifizieren Sie dann die Schritte, um den genopenapi Parser durch httprule zu ersetzen und dabei ein konsistentes Verhalten sicherzustellen. Prüfen Sie, ob es laufende Diskussionen oder verknüpfte PRs als Leitfaden gibt.
Tech Stack
go
Domain
backendapideveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go programminggRPC basicsCodebase navigation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40