Block 03 Modul 295

Fish API Dokumentation

Überblick

Fish API ist eine einfache REST API zum Verwalten und Abrufen von Fisch-Daten. Der Server bietet eine HTML-Oberfläche und JSON-API-Endpunkte.

Technologie-Stack

• Runtime: Node.js

• Protokoll: HTTP

• Port: 4010

• Datenspeicher: JSON (data.json)

Installation & Start

node server.js

Der Server startet auf http://localhost:4010

API-Endpunkte

1. Alle Fische abrufen

GET /api/fish

Gibt alle Fische als JSON-Array zurück.

Beispiel:

curl http://localhost:4010/api/fish

2. Einzelnen Fisch abrufen

GET /api/fish?id=1

Gibt einen spezifischen Fisch basierend auf der ID zurück.

Beispiel:

curl 'http://localhost:4010/api/fish?id=1'

3. HTML-Oberfläche

GET /

GET /index.html

Öffnet die interaktive Webseite in einem Browser.

4. Dokumentation

GET /doku

GET /doku.html

Zeigt die HTML-Dokumentationsseite.

Datenstruktur

Jeder Fisch hat folgende Eigenschaften:

• id (Nummer): Eindeutige Identifikator

• name (Text): Name des Fisches

• habitat (Text): Lebensraum/Gewässer

• color (Text): Farbe/Färbung

• weightKg (Dezimalzahl): Gewicht in Kilogramm

Beispiel:

{

"id": 1,

"name": "Clownfisch",

"habitat": "Korallenriff",

"color": "Orange-Weiss",

"weightKg": 0.25

}

Verfügbare Fische

1. Clownfisch - Orange-Weiß, 0,25 kg, Korallenriff

2. Blauer Doktorfisch - Blau-Gelb, 0,6 kg, Tropische Gewässer

3. Kugelfisch - Gelb-Braun, 1,5 kg, Küstengewässer

Verwendung

Browser

1. Navigiere zu http://localhost:4010

2. Stelle eine Tabelle mit allen Fischen dar

3. Füge Details via index.html an

Command Line / Postman

Verwende beliebige HTTP-Clients: curl, Postman, oder VS Code REST Client

Fehlerbehandlung

• 404: Route nicht gefunden

• 404: Fisch mit ID nicht gefunden

• 500: Fehler beim Lesen der Datendatei

Dateien

• server.js - Hauptserver-Code

• data.json - Fisch-Datenbank

• index.html - Frontend-Oberfläche

• anleitung.md - Diese Dokumentation

Auf dem Server:

Jede ID funktioniert von id=1 bis id=3 also jeder Fisch geht.

Es gibt sogar ein Error handling im letzten Screenshot oben.