https://github.com/iamrajiv/helloworld-grpc-gateway
This project is a basic hello world program utilizing gRPC-Gateway. It was developed as part of my participation in Google Season of Docs 2020 with gRPC-Gateway. The goal of this project is to introduce and familiarize individuals with gRPC-Gateway.
https://github.com/iamrajiv/helloworld-grpc-gateway
go grpc grpc-gateway protobuf rest
Last synced: 15 days ago
JSON representation
This project is a basic hello world program utilizing gRPC-Gateway. It was developed as part of my participation in Google Season of Docs 2020 with gRPC-Gateway. The goal of this project is to introduce and familiarize individuals with gRPC-Gateway.
- Host: GitHub
- URL: https://github.com/iamrajiv/helloworld-grpc-gateway
- Owner: iamrajiv
- License: mit
- Created: 2020-12-13T08:42:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T01:54:22.000Z (about 2 years ago)
- Last Synced: 2025-04-17T19:17:36.053Z (20 days ago)
- Topics: go, grpc, grpc-gateway, protobuf, rest
- Language: Go
- Homepage: https://app.swaggerhub.com/apis/iamrajiv/Hello_World_gRPC-Gateway/2
- Size: 147 KB
- Stars: 42
- Watchers: 1
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hello World gRPC-Gateway
Simple hello world program which uses gRPC-Gateway
## About
This project is a basic hello world program utilizing gRPC-Gateway. It was developed as part of my participation in [Google Season of Docs 2020](https://github.com/iamrajiv/GSoD-2020) with [gRPC-Gateway](https://github.com/grpc-ecosystem/grpc-gateway). The goal of this project is to introduce and familiarize individuals with gRPC-Gateway.
All the tutorials related to Hello World gRPC-Gateway have been added to the [gRPC-Gateway documentation website](https://grpc-ecosystem.github.io/grpc-gateway/docs/tutorials/).
The folder structure of the project is as follows:
```shell
.
├── LICENSE
├── Makefile
├── README.md
├── assets
│ └── helloworld-grpc-gateway.svg
├── buf.gen.yaml
├── buf.yaml
├── go.mod
├── go.sum
├── main.go
└── proto
├── google
│ └── api
│ ├── annotations.proto
│ └── http.proto
└── helloworld
├── hello_world.pb.go
├── hello_world.pb.gw.go
├── hello_world.proto
├── hello_world.swagger.json
└── hello_world_grpc.pb.go
```
## Usage
#### Installation
Before running this project, we need to install the required Go packages. To do this, run the following command:
```shell
make install
```
#### Generating stubs
We can generate the stubs for the project using the following command:
```shell
make generate
```
#### Cleaning stubs
To delete the stubs, use the following command:
```shell
make clean
```
#### Running the server
To run the server, use the following command:
```shell
go run main.go
```
#### Sending HTTP Requests
To send an HTTP POST request to the server, use cURL with the following command:
```shell
curl -X POST -k http://localhost:8090/v1/example/echo -d '{"name": "hello"}'
```
The server will respond with the following message:
```shell
{"message":"hello world"}
```
Note that the server runs on port 8090 and the endpoint is `/v1/example/echo`. The `name` field in the request is used in the response message.
## Swagger UI
We can view and test the API using the Swagger UI at the following link: [https://app.swaggerhub.com/apis/iamrajiv/Hello_World_gRPC-Gateway/2](https://app.swaggerhub.com/apis/iamrajiv/Hello_World_gRPC-Gateway/2).
## License
[MIT](https://github.com/iamrajiv/helloworld-grpc-gateway/blob/main/LICENSE)