Dota Showcase - Inventory Service

REST API service to store and track changes of steam user's dota 2 inventory items.

Features

• Inventory history - created, updated, deleted items
• Rate limiter
• Unit tests

API Docs

Swagger OpenAPI 3 is available by path:

• UI: host:port/swagger-ui.html
• JSON: host:port/api-docs

Inventory Endpoints

• Show Inventories: GET /api/v1/inventories
• Search Inventories (paginated): GET /api/v1/inventories/search-page
• Create an Inventory (load items from steam): POST /api/v1/inventories/:steamid
• Show an Inventory: GET /api/v1/inventories/:steamid
• Update an Inventory (reload items from steam): PUT /api/v1/inventories/:steamid
• Delete an Inventory: DELETE /api/v1/inventories/:steamid

Inventory Items Endpoints

• Search Inventory Items (filter with large payloads): POST /api/v1/inventories/:steamid/items/search
• Search Inventory Items (paginated; filter with large payloads): POST /api/v1/inventories/:steamid/items/search-page
• Show Inventory Items (positioned pagination): GET /api/v1/inventories/:steamid/items/page-positioned
• Show Inventory Items 'defIndex' fields: GET /api/v1/inventories/:steamId/items/def-indexes
• Show Inventory Items changes: GET /api/v1/inventories/:steamid/changes/:version

Operations Endpoints

• Search Operations (paginated): GET /api/v1/inventories/:steamid/operations/search-page

Getting Started

Prerequisites

• Java 21
• Apache Maven
• MongoDB 8.0

Installation

1. Create .env based on .env.example
2. Create environment.properties based on environment.properties.example in app/src/main/resources
3. Set the steam api key property to access Steam's API:

   env.steam.api.key=your_api_key

4. To run in development environment. You can use a default build for IntelliJ IDEA to run the app - .run/dev-build.run.xml.

   docker-compose up

5. To run in production environment

   docker compose -f docker-compose.prod.yml up -d

Data Model

Conceptual entity relation diagram (Barker's system):

Back-of-the-envelope Estimations

Storage Space

Assumptions:

• Average inventory item size - 500 bytes.
• Average user has 5000 inventory items.
• Users update inventory once per day. Each day it increased by some small coefficient (0.05).
• Data is stored for a year.

Estimate:

• User inventory size: 500 B * 5000 = 2.5 MB
• User inventory size for a year: 2.5 MB + (365 * 0.05 * 2.5 MB) = ~50 MB
• Storage for 100K users: 50MB * 100000 = ~5 TB

Resources

• Steam API - GetPlayerItems

Issues

Run tests on linux - problem with flapdoodle embedded mongo db

Download & install libssl1.1 latest version:

wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb

License

The GNU General Public License v3.0. Please see License File for more information.