api-design
REST-APIs mit Best Practices entwerfen
또한 다음에서 사용할 수 있습니다: supercent-io
APIs leiden oft unter inkonsistenter Benennung, schlechter URL-Struktur und falscher Verwendung von HTTP-Methoden. Diese Skill bietet klare Richtlinien für das Design von APIs, die intuitiv, skalierbar und leicht zu warten sind.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-design" 사용 중입니다. Entwerfe einen REST-Endpunkt zum Erstellen und Abrufen von Bestellungen
예상 결과:
- POST /orders - Neue Bestellung erstellen (gibt 201 Created mit Location-Header zurück)
- GET /orders?status=pending&sort=-createdAt - Bestellungen mit Filterung und Sortierung auflisten
- GET /orders/{id} - Bestimmte Bestellung abrufen (gibt 404 zurück, wenn nicht gefunden)
- Alle Antworten verwenden das Envelope-Format mit 'data'- und 'meta'-Feldern
"api-design" 사용 중입니다. Wie sollte ich Fehlerantworten für Validierungsfehler strukturieren?
예상 결과:
- Verwende 400 Bad Request mit dem Fehlercode VALIDATION_ERROR
- Inkludiere ein Details-Array mit feld-spezifischen Nachrichten
- Beispiel: { error: { code: 'VALIDATION_ERROR', message: 'Ungültige Eingabe', details: [{ field: 'email', message: 'Muss gültige E-Mail sein' }] } }
보안 감사
안전This is a documentation-only skill containing REST API design guidelines. All 99 static findings are false positives triggered by documentation examples being misinterpreted as executable code. No executable code, network calls, file system access, or external commands exist in this skill.
위험 요인
🌐 네트워크 접근 (1)
⚙️ 외부 명령어 (41)
🔑 환경 변수 (1)
품질 점수
만들 수 있는 것
Neue REST-APIs entwerfen
Best Practices beim Entwerfen neuer REST-Endpunkte anwenden, um Konsistenz und Benutzerfreundlichkeit zu gewährleisten.
Bestehende APIs überprüfen
Aktuelle API-Designs gegen Industriestandards validieren und Verbesserungsbereiche identifizieren.
API-Styleguides erstellen
Team-weite Konventionen für URL-Benennung, Antwortformate und Fehlerbehandlung etablieren.
이 프롬프트를 사용해 보세요
Entwerfe einen REST-Endpunkt für die Benutzerverwaltung. Bette die URL-Struktur, HTTP-Methode, Request-Body-Format, Antwortformat und geeignete Statuscodes ein.
Wie ist der richtige Weg, Fehlerantworten in einer REST-API zu strukturieren? Zeige Beispiele für Validierungsfehler, Authentifizierungsfehler und Nicht-Gefunden-Szenarien.
Entwerfe eine REST-API für paginierte Collections. Zeige sowohl offset-basierte als auch cursor-basierte Pagination-Ansätze mit Request- und Antwortbeispielen.
Was sind die Best Practices für API-Versionierung? Vergleiche URL-Pfad-Versionierung versus Header-basierte Versionierung. Wann sollte welcher Ansatz verwendet werden?
모범 사례
- Verwende pluralische Substantive für Ressourcen-URLs (z.B. /users nicht /user)
- Wende HTTP-Methoden korrekt an: GET für Lesezugriffe, POST für Erstellungen, PUT für Ersetzungen, PATCH für partielle Aktualisierungen, DELETE für Löschungen
- Strukturiere Antworten konsistent mit dem Envelope-Format inklusive Metadaten für Collections
피하기
- Vermeide Verben in URLs (z.B. /getUsers, /createOrder) - die HTTP-Methode vermittelt die Aktion
- Verwende keine inkonsistenten Namenskonventionen wie das Mischen von snake_case und camelCase in derselben API
- Vermeide tiefe Verschachtelung über zwei Ebenen hinaus - flache Ressourcen-Hierarchien, wenn möglich