API GATEWAY

Description

This repo contains project that act as an api-gateway. This service is part of a big system. The whole system will be used to present micro-services without an orchestrator.

Features

• Forward request from a client to corresponding service:
  • Entertainment service:
    • Translate http request/response to gRPC request/response.
    • Load balance request to available services.
    • Auto-retry if any error has occurred.
    • Prevent request failure using circuit breaker mechanism.
  • Covid-19 service:
    • Forward http request/response to http request/response.
    • Load balance request to available services.
    • Auto-retry if any error has occurred.
    • Prevent request failure using circuit breaker mechanism.

API

Please refer to all proto file here for more detail about the provided API. You can use gRPC by:

• Installing protoc
• Installing protoc-gen-go
• Generating code by executing protoc -I./proto --go_out=plugins=grpc:. proto/*/*.proto

How to run

Docker

• Install docker
• Create following environment variable and fill it with the right value

  SERVICE_NAME=api-gateway
  CONSUL_ADDRESS=http://consul-server-address
  ENTERTAINMENT_SERVICE_ADDRESS=entertainment-service-address-1,entertainment-service-address-2
  COVID19_SERVICE_ADDRESS=covid19-service-address-1,covid19-service-address-2
  TRACER_AGENT_ADDRESS=localhost:5775

CONSUL_ADDRESS is currently not used cause the service discovery feature is under maintenance

• Build and run docker image as below

$ docker build -t api-gateway .
$ docker run -p 8081:8080 api-gateway

Tech / Dependency

• Go kit - service
• gRPC - api
• Gorilla mux - api