API-Design und Spezifikation
Entwerfen Sie eine durchdachte API-Spezifikation nach REST- oder GraphQL-Best-Practices.
Prompt-Vorlage
Entwirf eine professionelle API-Spezifikation für [PROJEKTBESCHREIBUNG]. **API-Anforderungen:** - Zielgruppe: [ZIELGRUPPE: intern/extern/Partner] - Protokoll: [REST/GraphQL/gRPC] - Authentifizierung: [AUTH-METHODE] **Bitte erstelle:** 1. **Ressourcen-Modell:** Definiere die Hauptressourcen und ihre Beziehungen 2. **Endpunkte:** Liste alle Endpunkte mit HTTP-Methoden, Pfaden und Beschreibungen 3. **Request/Response Schemas:** Definiere die Datenstrukturen mit Typen und Validierungen 4. **Fehlerbehandlung:** Standardisierte Fehlercodes und -nachrichten 5. **Paginierung:** Strategie für große Datenmengen (Cursor-based oder Offset) 6. **Versionierung:** Empfohlene Versionierungsstrategie 7. **Rate Limiting:** Vorgeschlagene Limits und Headers **Ausgabeformat:** Erstelle die Spezifikation im OpenAPI 3.0 Format (YAML) mit Beispiel-Requests und -Responses.
Platzhalter in [eckigen Klammern] ersetzen: [PROJEKTBESCHREIBUNG][ZIELGRUPPE: intern/extern/Partner][REST/GraphQL/gRPC][AUTH-METHODE]
So verwendest du die Vorlage
Kopiere den Prompt, ersetze die Platzhalter in eckigen Klammern durch deine Angaben und füge ihn in den KI-Assistenten deiner Wahl ein. Je genauer die Angaben, desto besser das Ergebnis.
Tipps für bessere Ergebnisse
- Beschreiben Sie die Geschäftslogik und Anwendungsfälle detailliert
- Geben Sie an, ob die API öffentlich oder intern genutzt wird
- Fragen Sie nach Idempotenz-Strategien für kritische Operationen
- Bitten Sie um eine Postman-Collection als Bonus
Passende offene Modelle
Die Auswahl nennt aktuelle offene Modelle als Ausgangspunkt für eigene Tests. Sie ist keine Messung für diese Vorlage.
Stichwörter: #api-design #rest #openapi #architecture