REST-API designen
RESTful API-Design mit Endpunkten, Datenmodellen und Fehlerbehandlung.
- rest api
- api design
- backend
- endpunkte
- http
01Vorlage
Anpassen und kopieren
## 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.Prüfe das Ergebnis, bevor du es weiterverwendest. Modelle erfinden Details, wenn Angaben fehlen.
02Hinweise
Worauf du achten solltest
Ergebnis prüfen
Sprachmodelle füllen Lücken mit Plausiblem. Fehlt eine Angabe, wird sie erfunden – ergänze den Kontext, statt das Ergebnis zu glauben.
Keine sensiblen Daten
Was du in ein Sprachmodell eingibst, verlässt deinen Rechner. Personen- und Vertragsdaten gehören nicht in einen Prompt.
Modell wählen
Die Vorlage funktioniert mit allen gängigen Modellen. Für längere Aufgaben lohnt ein Modell mit größerem Kontextfenster.
03Sammlung Code
Weitere Vorlagen dieser Sammlung
Accessibility-Audit durchführen
Website oder App auf WCAG 2.1 Barrierefreiheit prüfen und Fixes vorschlagen.
API-Dokumentation schreiben
Vollständige API-Dokumentation mit Endpunkten, Parametern und Beispielen.
Architektur-Review
Software-Architektur auf Skalierbarkeit, Wartbarkeit und Risiken prüfen.
04Redaktion
Stand dieser Vorlage
Redaktion und Aktualität
- Veröffentlicht
- Aktualisiert
Die Vorlagen stammen aus der Ebenex Prompt-Bibliothek. Oben stehen Veröffentlichung und letzte Änderung.