API Documentation

API Documentation

This page contains API documentation for the RPG Handy Helper project.

API Structure

All API endpoints are available under the base path /api/v1.

Controller Categories

Notes

• GameNoteController - Game notes management

Scheduler

• SchedulerController - Scheduler management

User

• UserController - User management

Forgot Password

• ForgotPasswordController - Forgot password function management

Register

• RegisterController - Register function management

Rpg Systems

• RpgSystemsController - Rpg systems management

Game

• GameController - Games management

Game Room

• GameRoomController - Game room management

Cyberpunk Red

Manual Controllers

• AmmunitionController - Ammunition management
• ArmorsController - Armors management
• ClassesController - Classes management
• CriticalInjuriesController - Critical injuries management
• CyberwaresController - Cyberwares management
• EquipmentsController - Equipments management
• SKillsController - Skills management
• StatsController - Stats management
• WeaponsController - Weapons management
• WeaponModsController - Weapon mods management

Compatibility Controllers

• AmmunitionCompatibilityController - Ammunition compatibility management
• ModCompatibilityController - Weapon mods compatibility management

Custom Controllers

• CustomAmmunitionController - Custom ammunition management
• CustomArmorsController - Custom armors management
• CustomCriticalInjuriesController - Custom critical injuries management
• CustomCyberwaresController - Custom cyberwares management
• CustomEquipmentsController - Custom equipments management
• CustomWeaponModsController - Custom weapon mods management
• CustomWeaponsController - Custom weapons management

Character Controllers

• CharacterAmmunitionController - Character ammunition management
• CharacterArmorController - Character armor management
• CharacterClassesController - Character classes management

Other Categories

Links to documentation for other controllers will be added here as they are created.

Data Formats

The API uses JSON format for data exchange. Most endpoints return data as Map<String, Object>.

Authentication

Endpoints requiring authentication are located under the path /api/v1/authorized/*.