Skip to content

README.de.md

Latest commit

 

History

History
156 lines (122 loc) · 4.16 KB

README.de.md

File metadata and controls

156 lines (122 loc) · 4.16 KB

EasyAPI

Java 21 Build with Maven License: Apache-2.0

🌍 Verfügbare Sprachen: English | Deutsch

EasyAPI

EasyAPI ist eine leichte, allgemeine Java‑Bibliothek.
Sie bietet Helfer für asynchrone Ausführung, Logging, REST‑HTTP‑Aufrufe, Datei-/YAML‑Utilities, Laufzeitmetriken, Versions‑Utilities, ein kleines Konsolen‑Command‑Framework sowie Minecraft‑Utilities (z. B. Mojang‑UUID‑Lookup).

Projekt-Setup: Java 21, Maven, Apache‑2.0‑Lizenz
Maven‑Koordinaten: de.einfachesache:api:1.0

📦 Abhängigkeit

Wenn du JitPack verwendest, füge dies zu deiner pom.xml hinzu:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.EinfacheSache</groupId>
        <artifactId>EasyAPI</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

📋 Inhaltsverzeichnis

🚀 Funktionen

  • AsyncExecutor — leichter Scheduler mit safe()‑Wrapper für Fehlerbehandlung.
  • Logging — Logback/SLF4J‑Bridge mit benutzerdefinierten Convertern.
  • REST‑Utilities — OkHttp‑Wrapper mit GET/POST/DELETE‑Hilfsfunktionen.
  • Dateien & YAML — Lese-/Schreib‑Helfer.
  • Laufzeitmetriken — Speicher/CPU/Laufzeit überwachen.
  • Versions‑Utilities — Versionen vergleichen und Updates prüfen.
  • Konsolen‑Commands — minimales Framework zum Registrieren von Commands.
  • Minecraft — Utilities für Mojang‑UUID/Name‑Lookup.

⚙ Voraussetzungen

  • Java 21+
  • Maven 3.9+

🔧 Installation

Option A: Lokal bauen

mvn clean install

Danach auf de.cubeattack:api:1.0 als Abhängigkeit verweisen.

Option B: Über JitPack nutzen

Siehe Abschnitt Abhängigkeit oben.

💻 Anwendungsbeispiele

Asynchrone Tasks

AsyncExecutor.getService().schedule(
    AsyncExecutor.safe(() -> {
        // async work here
    }),
    1, java.util.concurrent.TimeUnit.SECONDS
);

REST‑Requests

RestAPIUtils http = new RestAPIUtils();
var res = http.request("GET", "https://example.com/api", null);
if (res != null && res.isSuccessful()) {
    System.out.println(res.body().string());
}

Minecraft‑UUID‑Lookup

UUID id = MinecraftAPI.getUUID("Notch");
System.out.println(id);

📂 Module / Pakete

  • de.einfachesache.api — Core‑Utilities
  • de.einfachesache.api.console — Konsolen‑Framework
  • de.einfachesache.api.logger — Logging
  • de.einfachesache.api.minecraft — Minecraft‑Utilities
  • de.einfachesache.api.util — Sonstige Utilities (Dateien, Laufzeit, REST, etc.)
  • de.einfachesache.api.util.version — Versionsvergleich

🏗 Aus dem Quellcode bauen

mvn clean package
# Ausgabe: target/EasyAPI-1.0-SNAPSHOT.jar

📦 Abhängigkeiten

Deklariert in der pom.xml:

  • com.google.code.gson:gson
  • ch.qos.logback:logback-classic (scope: provided)
  • org.slf4j:slf4j-simple
  • org.bspfsystems:yamlconfiguration
  • com.squareup.okhttp3:okhttp (scope: provided)
  • commons-io:commons-io (scope: provided)

📜 Lizenz

Apache‑2.0 — siehe LICENSE.md