Plavatar

A stateless microservice that returns placeholder avatars (=plavatars).

API Endpoints

• baseurl:port/laughing/<size>/<name>
• baseurl:port/smiley/<size>/<name>
• baseurl:port/happy/<size>/<name>
• baseurl:port/gradient/<size>/<name>
• baseurl:port/pixel/<size>/<name>
• baseurl:port/marble/<size>/<name>
• baseurl:port/solid/<size>/<name>

Without name:

• baseurl:port/laughing/<size> and so on

Parameters

• size the image's size in pixels. has to be min 16, max 1024
• name optional, the random number generator seed to use. given the same name the same picture will be returned

Deployment

By the default the program looks for a config file at <running_folder>/config/plavatar.json. If you want to use an alternative location you can override this behaviour using the argument --config <path_to_config>. If there's neither a config in the config/ folder, nor you supply a path with --config the default configuration will be used.

Default configuration file

{
  "dimensions": {
    "min": 128,
    "max": 512
  },
  "webserver": {
    "gzip": false,
    "http": {
      "enabled": true,
      "host": "0.0.0.0",
      "port": 7331
    },
    "https": {
      "enabled": false,
      "host": "0.0.0.0",
      "port": 7332,
      "cert": "testing.crt",
      "key": "testing.key"
    }
  },
  "caching": {
    "enabled": true,
    "ttl": "8h"
  },
  "metrics": {
    "enabled": false,
    "auth": {
      "enabled": true,
      "username": "",
      "password": ""
    }
  }
}

Testing

To generate a self-signed certificate for testing purposes you can use openssl req -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -out testing.crt -keyout testing.key

For benchmarking, you can use the provided k6 script under scripts/k6_plavatar_benchmark.js.