REST-API designen
RESTful API-Design mit Endpunkten, Datenmodellen und Fehlerbehandlung.
## Rolle Du bist ein API-Designer mit Fokus auf Developer Experience. ## Kontext Anwendungsfall: [BESCHREIBUNG] Hauptressourcen: [LISTE DER ENTITÄTEN] Authentifizierung: [JWT / OAuth / API Key] Versionierung: [JA / NEIN] ## Aufgabe Designe eine RESTful API. ## Format 1. Ressourcen und URL-Struktur 2. Endpunkte (Methode, URL, Beschreibung) 3. Request/Response-Datenmodelle (JSON) 4. Fehlerbehandlung (Fehlercodes und -formate) 5. Authentifizierungs-Flow 6. Versionierungsstrategie ## Constraints RESTful-Prinzipien einhalten. Konsistente Namensgebung. - **Fehlender Kontext:** Wenn wichtige Angaben fehlen, stelle gezielte Rückfragen statt generische Antworten zu produzieren. - Wenn der Code-Kontext unklar ist, frage nach Sprache, Framework und Version. ## Profi-Optionen - Erkläre die Entscheidungen hinter deiner Implementierung. - Nenne 1-2 alternative Ansätze und wann diese besser wären. - Weise auf mögliche Skalierungsprobleme hin.
Über diesen Prompt
Dieser Experte-Prompt aus der Kategorie Code hilft dir bei: RESTful API-Design mit Endpunkten, Datenmodellen und Fehlerbehandlung. Der Prompt folgt einer klaren Struktur mit Rolle, Kontext, Aufgabe, Format und Constraints – so bekommst du von ChatGPT, Claude oder Gemini präzise, verwertbare Ergebnisse statt generischer Texte. Relevante Themen: rest api, api design, backend, endpunkte, http.
Du kannst diesen Prompt direkt kopieren oder im Prompt-Builder weiter anpassen. Ersetze einfach die Platzhalter in eckigen Klammern mit deinen konkreten Angaben – je mehr Kontext du lieferst, desto besser das Ergebnis.
So verwendest du diesen Prompt
- Prompt kopieren
Klicke auf „Prompt kopieren" oben rechts.
- Platzhalter ersetzen
Ersetze alle Angaben in
[ECKIGEN KLAMMERN]mit deinen konkreten Informationen. Je mehr Kontext du gibst, desto besser das Ergebnis. - In KI-Modell einfügen
- Ergebnis verfeinern
Nicht zufrieden? Nutze den Prompt-Builder um den Prompt weiter anzupassen.