Repository navigation
Home
Dieses Projekt stellt einen einfachen Webservice bereit, der zufällige Programmierer-Witze über eine HTTP-API ausliefert. Der Webservice wurde mit Express.js entwickelt und lauscht auf Port 3000.
- Node.js Version ab 18 (laut
package-lock.jsonundexpressEngines) - npm oder ein kompatibler Paketmanager (z.B. yarn, pnpm)
-
Repository klonen:
git clone https://github.com/GregorBiswanger/ai-dev-process-sample.git cd ai-dev-process-sample -
Abhängigkeiten installieren:
npm install
Führe folgenden Befehl aus, um den Webservice zu starten:
node server.jsDer Server startet dann auf http://localhost:3000 und gibt folgende Meldung in der Konsole aus:
Joke-Webservice läuft auf http://localhost:3000
-
Methode: GET
-
Beschreibung: Liefert einen zufälligen Programmierer-Witz zurück.
-
Antwort: JSON-Objekt mit den folgenden Eigenschaften:
Schlüssel Typ Beschreibung jokeString Der zufällige Witztext -
Beispiel:
Request:
curl http://localhost:3000/api/jokes
Response:
{ "joke": "Warum benutzen Programmierer immer Brillen? Weil sie nicht C sharp sehen!" }
- Die Witzliste ist im Array
jokesin der Dateiserver.jsdefiniert und kann dort erweitert oder geändert werden. - Der Server verwendet Express Version 5.2.1.
- Der Server ist für einfache Demonstrationszwecke konzipiert und beinhaltet keine ausführlichen Fehlerbehandlungen oder komplexen Middleware-Funktionen.
- Für zukünftige Erweiterungen können weitere Routen oder Features in
server.jshinzugefügt werden.
Das Projekt enthält eine .gitignore-Datei, welche folgende Dateien/Ordner vom Git-Tracking ausschließt:
-
node_modules/(Abhängigkeiten) - Logdateien wie
npm-debug.log*,yarn-debug.log*etc. - Build-Output Ordner (
dist/,build/,.next/,out/) - Coverage Ordner (
coverage/) - Umgebungsvariablen-Dateien (
.env,.env.*außer.env.example) - Betriebssystem- und Editor spezifische Dateien (
.DS_Store,.vscode/,.idea/,Thumbs.db) - Logs und Log-Dateien (
logs/,*.log)
- GitHub URL: https://github.com/GregorBiswanger/ai-dev-process-sample
- Issues: https://github.com/GregorBiswanger/ai-dev-process-sample/issues
Dieses Projekt stellt einen minimalen Webservice bereit, der über einen API-Endpunkt /api/jokes einen zufälligen Witz zurückgibt. Die Nutzung ist einfach:
- Node.js Umgebung einrichten
- Abhängigkeiten installieren mit
npm install - Server starten mit
node server.js - API nutzen unter
http://localhost:3000/api/jokes
Ideal als Beispiel für Express.js und einfache API-Entwicklung.