grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2 824 ouverte le 31 juil. 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Go (2 250 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (16 971 stars)
Métriques de merge PR
 (Merge moyen 1j 4h) (141 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Commencez par examiner l'analyseur httprule dans internal/httprule et l'analyseur OpenAPI dans protoc gen openapiv2/internal/genopenapi. Comprenez comment chaque analyseur lit les modèles de chemin et génère des routes. Recherchez les tests existants dans le package httprule. Identifiez ensuite les étapes pour remplacer l'analyseur genopenapi par httprule, en garantissant un comportement cohérent. Vérifiez s'il y a des discussions en cours ou des PR liées pour vous guider.
Stack technique
go
Domaine
backendapideveloper experience
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go programminggRPC basicsCodebase navigation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40