Nameko microservices example
Clone or download
Latest commit 7493aec Nov 16, 2018

README.md

Nameko Examples

Airship Ltd

Airship Ltd

Buying and selling quality airships since 2012

CircleCI

Prerequisites

Overview

Repository structure

When developing Nameko services you have the freedom to organize your repo structure any way you want.

For this example we placed 3 Nameko services: Products, Orders and Gateway in one repository.

While possible, this is not necessarily the best practice. Aim to apply Domain Driven Design concepts and try to place only services that belong to the same bounded context in one repository e.g., Product (main service responsible for serving products) and Product Indexer (a service responsible for listening for product change events and indexing product data within search database).

Services

Services

Products Service

Responsible for storing and managing product information and exposing RPC Api that can be consumed by other services. This service is using Redis as it's data store. Example includes implementation of Nameko's DependencyProvider Storage which is used for talking to Redis.

Orders Service

Responsible for storing and managing orders information and exposing RPC Api that can be consumed by other services.

This service is using PostgreSQL database to persist order information.

Gateway Service

Is a service exposing HTTP Api to be used by external clients e.g., Web and Mobile Apps. It coordinates all incoming requests and composes responses based on data from underlying domain services.

Marshmallow is used for validating, serializing and deserializing complex Python objects to JSON and vice versa in all services.

Running examples

Quickest way to try out examples is to run them with Docker Compose

$ docker-compose up

Docker images for RabbitMQ, PostgreSQL and Redis will be automatically downloaded and their containers linked to example service containers.

When you see Connected to amqp:... it means services are up and running.

Gateway service with HTTP Api is listening on port 8003 and these endpoitns are available to play with:

Create Product

$ curl -XPOST -d '{"id": "the_odyssey", "title": "The Odyssey", "passenger_capacity": 101, "maximum_speed": 5, "in_stock": 10}' 'http://localhost:8003/products'

Get Product

$ curl 'http://localhost:8003/products/the_odyssey'

{
  "id": "the_odyssey",
  "title": "The Odyssey",
  "passenger_capacity": 101,
  "maximum_speed": 5,
  "in_stock": 10
}

Create Order

$ curl -XPOST -d '{"order_details": [{"product_id": "the_odyssey", "price": "100000.99", "quantity": 1}]}' 'http://localhost:8003/orders'

{"id": 1}

Get Order

$ curl 'http://localhost:8003/orders/1'

{
  "id": 1,
  "order_details": [
    {
      "id": 1,
      "quantity": 1,
      "product_id": "the_odyssey",
      "image": "http://www.example.com/airship/images/the_odyssey.jpg",
      "price": "100000.99",
      "product": {
        "maximum_speed": 5,
        "id": "the_odyssey",
        "title": "The Odyssey",
        "passenger_capacity": 101,
        "in_stock": 9
      }
    }
  ]
}

Running tests

Ensure RabbitMQ, PostgreSQL and Redis are running and config.yaml files for each service are configured correctly.

$ make coverage