grpc-ecosystem/grpc-gateway

Replace openapiv2 path template parser with httprule parser

Open

#2.824 aberto em 31 de jul. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Go (2.250 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (16.971 stars)
Métricas de merge de PR
 (Mesclagem média 1d 4h) (141 fundiu PRs em 30d)

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 examinando o analisador httprule em internal/httprule e o analisador OpenAPI em protoc gen openapiv2/internal/genopenapi. Entenda como cada analisador lê modelos de caminho e gera rotas. Procure por quaisquer testes existentes no pacote httprule. Em seguida, identifique as etapas para substituir o analisador genopenapi pelo httprule, garantindo comportamento consistente. Verifique se há discussões em andamento ou PRs vinculados para orientação.
Pilha de tecnologia
go
Domain
backendapideveloper experience
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.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go programminggRPC basicsCodebase navigation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40