go-micro-services

HTTP up front, Protobufs in the rear.

3 years after

HTTP up front, Protobufs in the rear.

An demonstration of Golang micro-services that accept HTTP/JSON requests at API level and then leverage gRPC for inter-service communication.

new_sequence

The API Endpoint accepts HTTP requests at localhost:8080 and then spawns a number of RPC requests to the backend services.

Note: Data for each of the services is stored in JSON flat files under the /data/ directory. In reality each of the services could choose their own specialty datastore. The Geo service for example could use PostGis or any other database specializing in geospacial queries.

Setup

Docker is required for running the services https://docs.docker.com/engine/installation.

Protobuf v3 are required:

$ brew install protobuf --devel

Install the protoc-gen libraries:

$ go get -u github.com/golang/protobuf/{proto,protoc-gen-go}

Clone the repository:

$ git clone [email protected]:harlow/go-micro-services.git

Protobufs

If changes are made to the Protocol Buffer files use the Makefile to regenerate:

$ make pb

Run

To make the demo as straigforward as possible; Docker Compose is used to run all the services at once (In a production environment each of the services would be run (and scaled) independently).

$ make build
$ make run

Curl the endpoint with an invalid auth token:

$ curl http://localhost:8080 -H "Authorization: Bearer INVALID_TOKEN"
Unauthorized

Curl the endpoint without checkin or checkout dates:

$ curl "http://localhost:8080?inDate=2015-04-09" -H "Authorization: Bearer VALID_TOKEN"
Please specify outDate

Curl the API endpoint with a valid auth token:

$ curl "http://localhost:8080?inDate=2015-04-09&outDate=2015-04-10" -H "Authorization: Bearer VALID_TOKEN"

The JSON response:

{
    "hotels": [
        {
            "id": 1,
            "name": "Clift Hotel",
            "phoneNumber": "(415) 775-4700",
            "description": "A 6-minute walk from Union Square and 4 minutes from a Muni Metro station, this luxury hotel designed by Philippe Starck features an artsy furniture collection in the lobby, including work by Salvador Dali.",
            "address": {
                "streetNumber": "495",
                "streetName": "Geary St",
                "city": "San Francisco",
                "state": "CA",
                "country": "United States",
                "postalCode": "94102"
            }
        }
    ],
    "ratePlans": [
        {
            "hotelId": 1,
            "code": "RACK",
            "inDate": "2015-04-09",
            "outDate": "2015-04-10",
            "roomType": {
                "bookableRate": 109,
                "totalRate": 109,
                "totalRateInclusive": 123.17,
                "code": "KNG"
            }
        }
    ]
}

Tracing Information

apitrace

gRPC tracing information:

http://localhost:8080/debug/requests
http://localhost:8080/debug/events

Credits

Thanks to all the contributors. This codebase was heavily inspired by the following talks and repositories:

Related Repositories

go-micro

go-micro

A pluggable RPC framework for microservices ...

go-os

go-os

A microservice operating system library for Micro OS ...

go-plugins

go-plugins

Plugins for go-micro {registry, broker, codec, transport, ...} ...

awesome-go

awesome-go

A curated list of awesome Go frameworks, libraries and software. ...

go-web

go-web

A lightweight HTTP microservice library leveraging go-micro ...


Top Contributors

harlow isaiah jesselucas