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

Cyberpunk Red

Manual Controllers

• CpRedAmmunitionController - Ammunition management
• CpRedArmorsController - Armors management
• CpRedClassesController - Classes management
• CpRedCriticalInjuriesController - Critical injuries management
• CpRedCyberwaresController - Cyberware management
• CpRedEquipmentsController - Equipments management
• CpRedSKillsController - Skills 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/*.