💻 Coding Experte

REST API Design

Hilft beim Entwurf einer RESTful API nach Best Practices.

Prompt — klicken zum Bearbeiten
Entwirf eine REST API für: [PROJEKT/DOMAIN]

RESSOURCEN: [z.B. Users, Products, Orders]
AUTHENTIFIZIERUNG: [JWT/API Key/OAuth]
FRAMEWORK: [Express/FastAPI/Laravel/Spring Boot]

Für jede Ressource erstelle:
1. **ENDPUNKTE** (RESTful):
   - GET /resource - Liste (mit Pagination, Filter, Sort)
   - GET /resource/:id - Detail
   - POST /resource - Erstellen
   - PUT /resource/:id - Aktualisieren
   - DELETE /resource/:id - Löschen

2. **REQUEST/RESPONSE** Beispiele (JSON)

3. **VALIDIERUNG**: Eingabe-Validierungsregeln

4. **FEHLER-RESPONSES**: Standardisiertes Error-Format
   ```json
   {"error": {"code": "VALIDATION_ERROR", "message": "...", "details": [...]}}
   ```

5. **PAGINATION**: Cursor-based oder Offset-based
6. **RATE LIMITING**: Empfohlene Limits
7. **VERSIONIERUNG**: URL vs Header Strategy
8. **OpenAPI/Swagger**: Schema-Definition

Best Practices: HATEOAS, idempotent Operations, HTTP Status Codes.

Tipps

Starte mit den wichtigsten 2-3 Ressourcen und erweitere iterativ.

Erwartetes Ergebnis

Ein vollständiges REST API Design mit Beispielen und OpenAPI-Schema.

Anwendungsfall

Backend-Entwicklung und API-Design

212 Aufrufe 98 Kopien