grpc-ecosystem/grpc-gateway

Suggestion to document gateway transcoding support for other languages.

Open

#834 aberto em 20 de dez. de 2018

Ver no GitHub
 (12 comments) (0 reactions) (1 assignee)Go (2.250 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (16.971 stars)
Métricas de merge de PR
 (Mesclagem média 8d 23h) (147 fundiu PRs em 30d)

Description

If using the http annotations it's rather complicated to get code to compile across languages. Many resort to copying the common annotations in the project in order for protoc to generate the compile time dependencies (e.g. https://github.com/xolstice/protobuf-maven-plugin/issues/14) Instead you need https://github.com/googleapis/api-common-protos dependencies in each language to have them at compile time.

Also the protos need to be available to protoc when resolving the includes.

Guia do colaborador

Direção de pesquisa
Investigue os protos comuns no repositório api common protos e entenda como incluí los em diferentes linguagens. Revise a issue vinculada (xolstice/protobuf maven plugin#14) para ver as soluções típicas. Identifique as etapas exatas e as dependências necessárias por linguagem (Go, Java, Python, etc.) e proponha uma documentação que explique como configurar a compilação com os protos necessários. Consulte a documentação existente no repositório grpc gateway para padrões semelhantes.
Pilha de tecnologia
go
Domain
backendapi
Tipo Issue
Documentaçã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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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.
Claro
Prerequisites
Protobuf
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80