Problem

"Exercise: Write a simple fizz-buzz REST server.

"The original fizz-buzz consists in writing all numbers from 1 to 100, and just replacing all multiples of 3 by ""fizz"", all multiples of 5 by ""buzz"", and all multiples of 15 by ""fizzbuzz"". The output would look like this: ""1,2,fizz,4,buzz,fizz,7,8,fizz,buzz,11,fizz,13,14,fizzbuzz,16,...""."

Your goal is to implement a web server that will expose a REST API endpoint that:

• Accepts five parameters: three integers int1, int2 and limit, and two strings str1 and str2.
• Returns a list of strings with numbers from 1 to limit, where: all multiples of int1 are replaced by str1, all multiples of int2 are replaced by str2, all multiples of int1 and int2 are replaced by str1str2.

The server needs to be:

• Ready for production
• Easy to maintain by other developers

Bonus: add a statistics endpoint allowing users to know what the most frequent request has been. This endpoint should:

• Accept no parameter
• Return the parameters corresponding to the most used request, as well as the number of hits for this request"

Solution

I went for a simple prod ready solution with very few dependencies (sqlite, sqlmock, swaggo).

Quickstart

How to run tests

make test

How to run the service

make run

How to run wih docker

docker compose up -d fizzbuzz # port 8190 will be exposed

How to play with the endpoints

curl -v "http://localhost:8191/?int1=3&int2=5&limit=20&str1=buzz&str2=feed" | jq

get the stats

curl -v "http://localhost:8191/stat" | jq

A swagger page is provided to easily play with the service. Go to

http://localhost:<port>/swagger/