mirror of https://codeberg.org/andyscott/OpenWeather-gRPC-API.git synced 2024-11-12 06:30:47 -05:00

Microservice using gRPC to provide weather and geolocation data

geolocation geolocation-api go golang grpc grpc-go grpc-server microservice OpenWeatherMap weather weather-api

Find a file

Andrew Scott 2490ef3a7c Merge pull request 'Overhaul .proto files' (#1 ) from dev into main Reviewed-on: https://codeberg.org/andcscott/OpenWeatherMap-gRPC-API/pulls/1		2022-07-28 07:36:38 +02:00
info	Added UML diagram	2022-07-26 02:24:10 -04:00
proto	Organize and document .proto files, no changes to request formats	2022-07-28 01:27:11 -04:00
server	Update comments	2022-07-27 03:09:11 -04:00
test-client	Added location endpoint	2022-07-26 17:28:33 -04:00
.gitignore	Update .gitignore	2022-07-26 01:04:53 -04:00
go.mod	Corrected module path	2022-07-26 01:05:52 -04:00
go.sum	Added go.sum	2022-07-26 01:05:35 -04:00
LICENSE	Create LICENSE	2022-07-25 19:53:56 +02:00
README.md	Update 'README.md'	2022-07-26 10:05:48 +02:00

README.md

OpenWeatherMap-gRPC-API

A microservice that accepts remote procedure calls to fetch weather data.

The service uses protocol buffers to define a gRPC API that fetches current and extended weather data.

Weather data is obtained from OpenWeather's high-end servers.

Sending Requests

Basic Workflow

Generate the necessary code for your preferred language from the files in the proto directory with the protoc compiler
Import the code into your project
Use the imported code to allow your client to connect with the server
Use the imported code within your own functions to make requests

Generating code from the .proto files

Run protoc from the root of the project. The below example shows how one might generate Go code.

protoc -Iproto --go_opt=module=codeberg.org/andcscott/OpenWeatherMap-gRPC-API \
--go_out=. --go-grpc_opt=module=codeberg.org/andcscott/OpenWeatherMap-gRPC-API \
--go-grpc_out=. proto/*.proto

Importing the code

Import the code into your project. Example in Go:

import pb "codeberg.org/andcscott/OpenWeatherMap-gRPC-API/proto"

Using the imported code to connect to the server

First, enable your client to connect to the server. Example in Go:

conn, err := grpc.Dial("localhost:5000", grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
	log.Fatalln(err)
}
defer conn.Close()

c := pb.NewWeatherServiceClient(conn)

See the test-client for more details.

Using the imported code to make requests

In this case, we're requesting the current weather for Corvallis, OR.

func doCurrent(c pb.WeatherServiceClient) {
	res, err := c.Current(context.Background(), &pb.RequestCurrent{
		City: "Corvallis",
	})
	if err != nil {
		log.Fatalln(err)
	}
	log.Println(res.Payload)
}