https://github.com/bvwells/grpc-gateway-example

Example usage of gRPC gateway
https://github.com/bvwells/grpc-gateway-example

go golang grpc grpc-gateway openapi swagger

Last synced: about 1 month ago
JSON representation

Example usage of gRPC gateway

• Host: GitHub
• URL: https://github.com/bvwells/grpc-gateway-example
• Owner: bvwells
• License: mit
• Created: 2020-05-15T19:38:41.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-14T17:27:56.000Z (over 4 years ago)
• Last Synced: 2024-11-13T23:16:22.169Z (3 months ago)
• Topics: go, golang, grpc, grpc-gateway, openapi, swagger
• Language: Go
• Size: 1.25 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gRPC Gateway Example

[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/bvwells/grpc-gateway-example?tab=overview)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/bvwells/grpc-gateway-example)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/bvwells/grpc-gateway-example) 

[![Build Status](https://travis-ci.com/bvwells/grpc-gateway-example.svg?branch=master)](https://travis-ci.com/bvwells/grpc-gateway-example)

[![codecov](https://codecov.io/gh/bvwells/grpc-gateway-example/branch/master/graph/badge.svg)](https://codecov.io/gh/bvwells/grpc-gateway-example)

[![Go Report Card](https://goreportcard.com/badge/github.com/bvwells/grpc-gateway-example)](https://goreportcard.com/report/github.com/bvwells/grpc-gateway-example)

This repo contains an example usage of grpc gateway (https://github.com/grpc-ecosystem/grpc-gateway).

## Developing

Install protoc (https://github.com/protocolbuffers/protobuf)

```

brew install protobuf

```

Run 

```

go mod tidy

```

```

go install \

    github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway \

    github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger \

    github.com/golang/protobuf/protoc-gen-go \

    golang.org/x/tools/cmd/stringer \

    github.com/vektra/mockery/cmd/mockery \

    github.com/golangci/golangci-lint/cmd/golangci-lint

```

Add $GOBIN to path

```

export PATH=$PATH:~/go/bin

```

## Code generation 

From root of repo run:

```

go generate ./...

```

This will re-generate required code. Go generate will generate grpc server/client

stubs, the grpc gateway reverse proxy and open api definition for the protobuf

definition. These commands can be run independently by running the following

commands.

### Generate gRPC server/client stub

```

protoc -I. --go_out=plugins=grpc,paths=source_relative:./ api.proto

```

### Generate reverse-proxy using protoc-gen-grpc-gateway

```

protoc -I. --grpc-gateway_out=logtostderr=true,paths=source_relative:./ api.proto 

```

### Generate swagger definitions using protoc-gen-swagger

```

protoc -I. --swagger_out=disable_default_errors=true,logtostderr=true:../api/openapi-spec api.proto

```

## Run PostgreSQL database

To install PostgreSQL (https://www.postgresql.org/) run:

```

brew install postgresql

```

Run the docker image postgres (https://hub.docker.com/_/postgres):

```

docker run --rm --name beers -e POSTGRES_PASSWORD=ilovebeer -p 5432:5432 -v $HOME/Git/github.com/bvwells/grpc-gateway-example/pkg/infrastructure/postgres:/var/lib/postgresql/data postgres

```

NOTE: The environment variable POSTGRES_PASSWORD should be set to a secret when running in a real environment.

Connect to running instance:

```

psql -h localhost -U postgres -d postgres

```

To create the beers database run:

```

CREATE DATABASE BEERS;

```

Connect to the database:

```

\c beers

```

To create the beers table run:

```

CREATE TABLE BEERS (

  id VARCHAR(36) PRIMARY KEY,

  name TEXT,

  type INT,

  brewer TEXT,

  country TEXT

);

```

Some useful psql commands:

List databases:

```

\l 

```

Connect to a database:

```

\c table_name username

```

List tables:

```

\dt 

```

Describe a table:

```

\d table_name

```

Help:

```

\? table_name

```

## TODOs

- What to do with request headers?