grpc-ecosystem/grpc-gateway

Add example repo to README

Open

#3,208 opened on Feb 24, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

Description

Hi!

Thanks for all the work put into this project. It's really great.

I would like offer up a link to an example repo I've created. I was thinking that maybe this could be included in the README under the "examples" section.

It took me a while to figure out a few critical details for my use-case, so I thought that it may help others to have a complete example. I believe my project is a decent example (granted it's new and probably could be refined) of the following cases:

  • grpc-gateway handler within another (more standard) router, such as Chi
  • custom base path for all grpc routing with the openapi configuration to support
  • embedded Swagger UI without additional tooling

The demo project also details a few different patterns for defining and interacting with RPCs.

Contributor guide

Research direction
Look at the README examples section and identify where to add the example repo link. Ensure the link fits the existing formatting.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80