Products API

Table of Contents

• Products API
  • Table of Contents
  • Description
  • Basic Full Transaction Example
  • Usage
  • TODO
  • License

Description

Example of how to create a simple API that could be used as part of a commerce system or POS.

You can find information about the data models used here

Basic Full Transaction Example

1. Run the docker container with: make run-docker
2. Send a POST request to the container (this is done with curl): make transaction-test

You should see output similar to the following:
This output can be used by a receipt printer

{
    "order_id": "f488a533-11cd-4787-b0bb-a945b5cb382c",
    "formatted_products": [
        {
            "product_quantity": 1,
            "product_name": "Coffee Mug",
            "price": 599
        },
        {
            "product_quantity": 1,
            "product_name": "Coaster",
            "price": 250
        },
        {
            "product_quantity": 1,
            "product_name": "Glass Tumbler",
            "price": 1299
        }
    ],
    "formatted_date_time": "06-07-2018 23:13:19",
    "subtotal": 1943,
    "taxtotal": 389,
    "tax_breakdown": [
        {
            "Name": "VAT",
            "Amount": 0.2,
            "Total": 389
        }
    ],
    "total": 2332
}

Usage

How to build and run the API as a service. More information on these commands can be found in the Makefile

# Basic run while testing
make run
# Run test suite over all packages
make test
# Build Docker Image
make build
# Run Docker Image
make run-docker
# Deploy to Kubernetes Cluster
make deploy
# Make POST request to test creating a new transaction
make transaction-test
# Make POST request to test creating a new product and then GETting it
make product-test

TODO

• mock dependency on currency converter. Causes flaky tests due to changing conversion rates
• Abstract transaction totals to separate package and look at cleaner implementation
• Implement Data store
• Add authentication to API
• Improve transactions to better handle multiple quantities of the same product
• Tidy up test suites for improved readability
• Improve the healthz endpoint
• Add readyz endpoint
• Look to move to using gRPC

License

Apache 2.0