grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Open

#2.782 aberto em 3 de jul. de 2022

Ver no GitHub
 (1 comment) (3 reactions) (0 assignees)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 1d 4h) (141 fundiu PRs em 30d)

Description

📚 Documentation

I have generates the OpenAPI file with buf but for me it is not clear how can I add the swagger-ui to my gateway service. I have bind the the gateway-handler and this works. I would like to add a second path localhost:8081/doc a swagger-ui, so it is possible to show / test the gateway via REST request. Could be added an example to the documentation for adding the swagger-ui? I have got some open questions:

  • Did I need additional dependencies?
  • Can I build with buf the stub for the HTTP server?
  • Did I need some middelware component?
  • How can bind the mux of the grpc-gateway with the swagger-ui together?

Guia do colaborador

Direção de pesquisa
Investigue a documentação existente sobre integração OpenAPI no repositório grpc gateway (por exemplo, diretório docs/) e a pasta examples/. Procure por quaisquer exemplos ou referências existentes do swagger ui. A issue solicita a adição de um exemplo claro de hospedagem do swagger ui junto ao manipulador do gateway, incluindo dependências e vinculação MUX. Considere vincular a um PR ou comentário se encontrado.
Pilha de tecnologia
go
Domain
apidocumentation
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.
2
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.
Precisa de investigação
Prerequisites
GogRPCbufswagger ui
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60