API Design

FortgeschrittenEntwicklungMindestens 32K Kontext

Entwirft RESTful- und GraphQL-APIs nach Contract-first-Prinzipien. Behandelt Endpunktstruktur, Anfrage- und Antwortschemas, Fehlerbehandlung, Versionierung, Paginierung, Authentifizierung und Ratenlimits. Erstellt OpenAPI-/Swagger-Spezifikationen und Implementierungsgerüste.

Diese Beschreibung wurde automatisch übersetzt und noch nicht redaktionell geprüft.

Anwendungsfälle

  • Entwurf neuer REST-Endpunkte aus Anforderungen
  • Erstellung von OpenAPI-Spezifikationen
  • Entscheidungen zur API-Versionierungsstrategie
  • Standardisierung von Fehlerantworten
  • Entwurf von GraphQL-Schemas mit Resolvern

Beispiel-Prompt

Design a REST API for a task management system.

Requirements:
- CRUD operations for tasks (title, description, status, assignee, due_date)
- Task filtering by status, assignee, and date range
- Pagination with cursor-based navigation
- Proper error responses with problem details (RFC 7807)
- Authentication via Bearer token

Deliverables:
1. Endpoint list with HTTP methods and paths
2. Request/response schemas for each endpoint
3. Error response catalog
4. OpenAPI 3.1 specification
5. Rate limiting recommendations

Empfohlene Modelle

Kompatible Werkzeuge

claude-codecursorgithub-copilotkiroany

Modalitäten

Eingabe: text
→
Ausgabe: code, text

Ähnliche Skills

Autor

OpenModels Community

@openmodelsrun