grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Aberta

#2.824 aberto em 31 de jul. de 2022

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Go (2.250 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (16.971 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Comece entendendo o pacote httprule em internal/httprule e como ele é usado no protoc gen grpc gateway. Em seguida, examine o pacote genopenapi para ver como os templates de caminho são analisados. Identifique as diferenças e planeje uma refatoração para substituir o parser genopenapi pelo httprule. Garanta que os testes passem e que ambos os geradores produzam caminhos consistentes.
Pilha de tecnologia
go
Domain
backendapitooling
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GogRPCprotobuf
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
55