FeGmbH am 16. Juni 2026 um 19:00 Uhr

2026-06-16T19:00:09Z

← Nächstältere Version		Version vom 16. Juni 2026, 21:00 Uhr
Zeile 164:		Zeile 164:

	</pre>		</pre>
			[[Kategorie:Entwickler-Dokumentation]]

FeGmbH: Die Seite wurde neu angelegt: „NOTOC Mit dieser API-Schnittstelle kommuniziert der Client (Frontend) des Social Media Simulators mit dem Spring Boot-Backend, um Spielstände zu initialisieren und abzurufen. == Endpunkte Übersicht == {| class="wikitable" style="width:100%; border-radius: 8px; overflow: hidden;" ! style="width: 15%;" | Methode ! style="width: 35%;" | Endpunkt ! Beschreibung |- | style="background-color: #28a745; color: white; font-weight: bold; text-align: center;…“

2026-06-16T18:25:09Z

Die Seite wurde neu angelegt: „__NOTOC__ Mit dieser API-Schnittstelle kommuniziert der Client (Frontend) des Social Media Simulators mit dem Spring Boot-Backend, um Spielstände zu initialisieren und abzurufen. == Endpunkte Übersicht == {| class="wikitable" style="width:100%; border-radius: 8px; overflow: hidden;" ! style="width: 15%;" | Methode ! style="width: 35%;" | Endpunkt ! Beschreibung |- | style="background-color: #28a745; color: white; font-weight: bold; text-align: center;…“

Neue Seite

__NOTOC__
Mit dieser API-Schnittstelle kommuniziert der Client (Frontend) des Social Media Simulators mit dem Spring Boot-Backend, um Spielstände zu initialisieren und abzurufen.

== Endpunkte Übersicht ==

{| class="wikitable" style="width:100%; border-radius: 8px; overflow: hidden;"
! style="width: 15%;" | Methode
! style="width: 35%;" | Endpunkt
! Beschreibung
|-
| style="background-color: #28a745; color: white; font-weight: bold; text-align: center;" | GET
| <code>/api/init</code>
| Generiert eine neue Spieler-UUID (UTF-16).
|-
| style="background-color: #28a745; color: white; font-weight: bold; text-align: center;" | GET
| <code>/api/game</code>
| Ruft den aktuellen Spielstand für eine UUID ab.
|-
| style="background-color: #007bff; color: white; font-weight: bold; text-align: center;" | POST
| <code>/api/game/init_recall</code>
| Initialisiert ein neues Spiel mit einer Konfiguration.
|}

---

== Dokumentation der Endpunkte ==

=== 1. Spieler-UUID generieren ===
* '''Endpunkt:''' <code>/api/init</code>
* '''Methode:''' GET
* '''Format:''' <code>text/plain;charset=utf-16</code>

Diese Methode generiert eine neue, eindeutige V4-UUID, registriert sie im RAM des Servers in der aktiven Spielerliste und gibt sie als Byte-Array im UTF-16-Format zurück.

==== Rückgabe (Response) (Bsp.!) ====
<pre>
4f3b89a2-1e4d-4c6a-9b88-123456789abc
</pre>

---
=== 2. Spielstand abrufen ===
* '''Endpunkt:''' <code>/api/game</code>
* '''Methode:''' GET
* '''Format:''' <code>application/json</code>

Gibt den aktuellen Zustand der laufenden Simulation für die übergebene UUID zurück. Der Client nutzt diesen Endpunkt für den regelmäßigen Sync oder beim Neuladen des Dashboards.

==== Query-Parameter ====
{| class="wikitable"
! Parameter
! Typ
! Pflichtfeld
! Beschreibung
|-
| <code>id</code>
| UUID
| Ja
| Die eindeutige Kennung des Spielers, die über <code>/api/init</code> generiert wurde.
|}

==== Rückgabe (Response) ====
* '''Status 200 (Erfolgreich):''' Gibt das <code>GameResponse</code>-JSON-Objekt zurück, wenn die UUID existiert. Falls die ID nicht in der aktiven Spielerliste registriert ist, wird <code>null</code> zurückgegeben.

<pre>
{
"playerId": "4f3b89a2-1e4d-4c6a-9b88-123456789abc",
"companyName": "QuatschStudio Tech",
"money": 50000,
"employees": 1,
"researchPoints": 0
}
</pre>

===== Parameter-Spezifikation =====
{| class="wikitable"
! Feld
! Typ
! Beschreibung
|-
| <code>playerId</code>
| String (UUID)
| Die UUID des Spielers zur Validierung auf Client-Seite.
|-
| <code>companyName</code>
| String
| Der Name des Social-Media-Unternehmens.
|-
| <code>money</code>
| Integer
| Der aktuelle Kontostand des Unternehmens im Spiel.
|-
| <code>employees</code>
| Integer
| Die Anzahl der derzeit eingestellten Mitarbeiter.
|-
| <code>researchPoints</code>
| Integer
| Die aktuell angesammelten Forschungspunkte für neue Features oder Algorithmen-Upgrades.
|}
---
=== 3. Spiel initialisieren ===
* '''Endpunkt:''' <code>/api/game/init_recall</code>
* '''Methode:''' POST
* '''Format:''' <code>application/json</code>

Initialisiert die Spielmechaniken für eine bereits generierte UUID auf Basis der übergebenen Unternehmenseinstellungen im Request-Body.

==== Query-Parameter ====
{| class="wikitable"
! Parameter
! Typ
! Pflichtfeld
! Beschreibung
|-
| <code>id</code>
| UUID
| Ja
| Die ID des Spielers, für den das Spiel gestartet wird.
|}

==== Payload (Request Body) ====
Übergabe des <code>GameConfigDTO</code> als JSON-Objekt:
<pre>
{
"companyName": "QuatschStudio Tech",
"infiniteMoney": false,
"startMoney": 50000,
"startEmployees": 1,
"startResearch": 0
}
</pre>

===== Parameter-Spezifikation =====
{| class="wikitable"
! Feld
! Typ
! Beschreibung
|-
| <code>companyName</code>
| String
| Der Name des zu gründenden Social-Media-Unternehmens.
|-
| <code>infiniteMoney</code>
| Boolean
| Sandbox-Modus. Wenn <code>true</code>, ist das Startkapital unbegrenzt.
|-
| <code>startMoney</code>
| Integer
| Das verfügbare Startkapital bei Spielbeginn.
|-
| <code>startEmployees</code>
| Integer
| Die Anzahl der Mitarbeiter, mit denen das Unternehmen startet.
|-
| <code>startResearch</code>
| Integer
| Der initiale Wert für bereits generierte Forschungspunkte.
|}

==== Server-Log (SLF4J) ====
Beim Aufruf triggert der Controller einen Log-Eintrag auf dem Server (Bsp.!):
<pre>
2026-06-16T20:23:28.789+02:00 INFO 523700 --- [nio-8080-exec-6] o.r.smsim.api.controller.GameController : Setting up Game for 737e1e57-3e1d-4f0e-b1a8-1fcad8c145d0:GameConfigDTO [companyName=adsf, infiniteMoney=false, startMoney=1000, startEmployees=1, startResearch=0]

</pre>

API-Dokumentation - Versionsgeschichte

FeGmbH am 16. Juni 2026 um 19:00 Uhr