/grpc-service-template

Primary LanguageTypeScript

gRPC Gateway

About

This repository contains an example of how to use the gRPC-Gateway.

Requirements

Install

make install

Usage

Generating Protobuf and gRPC-Gateway Code

To generate the protobuf and gRPC-Gateway code, you can use the buf tool. The protobuf files are stored in the proto directory, and the generated code will be placed in the internal directory.

To generate the code, run the following command:

make generate

Run Server

go run main.go

Run Client

go run cmd/api/main.go

This will generate the necessary Go code for the protobuf files and the gRPC-Gateway files.

gRPC Requests and Responses

Once you've started both the gRPC and gRPC-Gateway servers using go run main.go, you can send gRPC requests and receive responses using a gRPC client.

Here's an example of how to send a gRPC request and receive a response using the grpcurl command-line tool:

  1. Install grpcurl by following the instructions in the official documentation.
  2. Open a new terminal window or tab and run the following command to send a gRPC request to the SayHello RPC:
grpcurl -plaintext -d '{"name": "Javier"}' localhost:8080 helloworld.v1.GreeterService/SayHello

This sends a gRPC request to the SayHello RPC with the name "Rajiv" as a request parameter.

  1. You should receive a response that looks like this:
{
  "message": "Hello, Javier!"
}

This is the response message returned by the SayHello RPC.

REST Requests and Responses

Once you've started both the gRPC and gRPC-Gateway servers using go run main.go, you can send REST requests and receive responses using a tool like curl.

Here's an example of how to send a REST request and receive a response using curl:

  1. Open a new terminal window or tab and run the following command to send a REST request to the /v1/helloworld endpoint:
curl -X POST http://localhost:8081/v1/helloworld -H "Content-Type: application/json" -d '{"name": "Rajiv"}'

This sends a POST request to the /v1/helloworld endpoint with a JSON payload containing the name "Rajiv".

  1. You should receive a response that looks like this:
{
  "message": "Hello, Rajiv!"
}