grpc-ecosystem/grpc-gateway

Add example repo to README

Open

#3208 opened on Feb 24, 2023

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

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

Tech stack
gogrpcrest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Add a link to the provided example repository (https://github.com/cosmotek/grpc template) in the README under the 'Examples' section. The example demonstrates grpc gateway usage with Chi router, custom base path, and embedded Swagger UI. Follow the existing formatting and style of the README.