Fähigkeiten api-design-principles

🧭

api-design-principles

Name: api-design-principles
Author: wshobson

Sicher 🌐 Netzwerkzugriff⚙️ Externe Befehle

Entwerfen Sie REST- und GraphQL-APIs mit Zuversicht

API-Design-Entscheidungen werden oft inkonsistent und schwer zu warten. Diese Fähigkeit bietet klare Muster, Vorlagen und Checklisten, um Ihre Entscheidungen zu leiten.

Unterstützt: Claude Codex Code(CC)

🥉 72 Bronze

Die Skill-ZIP herunterladen

In Claude hochladen

Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen

Einschalten und loslegen

Teste es

Verwendung von "api-design-principles". Überprüfen Sie meine Benutzer- und Bestellungsendpunkte auf REST-Best-Practices.

Erwartetes Ergebnis:

Verwenden Sie Pluralnomen: /api/users und /api/orders
Ersetzen Sie Aktionspfade wie /api/createUser durch POST /api/users
Fügen Sie Pagination zu Listenendpunkten mit page und page_size hinzu
Geben Sie 201 Created bei erfolgreichem POST und 204 bei DELETE zurück

Verwendung von "api-design-principles". Wie sollte ich ein GraphQL-Schema für einen Blog mit Benutzern, Beiträgen und Kommentaren strukturieren?

Erwartetes Ergebnis:

Definieren Sie User-, Post-, Comment-Typen mit proper relationships
Verwenden Sie Relay-Style-Cursor-Pagination für Sammlungen
Erstellen Sie Eingabetypen für Mutationen mit Fehler-Payloads
Fügen Sie DataLoaders hinzu, um N+1-Queries bei Beziehungen zu verhindern

Verwendung von "api-design-principles". Welche Statuscodes sollte meine API für Validierungsfehler zurückgeben?

Erwartetes Ergebnis:

Geben Sie 400 Bad Request bei fehlerhafter Anfragesyntax zurück
Geben Sie 422 Unprocessable Entity bei Validierungsfehlern zurück
Fügen Sie Details auf Feldebene in den Antworttext ein
Verwenden Sie ein konsistentes Fehlerformat für alle Endpunkte

Sicherheitsaudit

Sicher

v4 • 1/17/2026

This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.

Gescannte Dateien

2,011

Analysierte Zeilen

befunde

Gesamtzahl Audits

Risikofaktoren

🌐 Netzwerkzugriff (7)

assets/rest-api-template.py:182 references/rest-best-practices.md:132 references/rest-best-practices.md:133 references/rest-best-practices.md:134 references/rest-best-practices.md:135 references/rest-best-practices.md:324 skill-report.json:6

⚙️ Externe Befehle (134)

Auditiert von: claude Audit-Verlauf anzeigen →

Qualitätsbewertung

Architektur

Wartbarkeit

Inhalt

Community

100

Sicherheit

Spezifikationskonformität

Was du bauen kannst

Neue API-Standards definieren

Erstellen Sie konsistente REST- und GraphQL-Regeln für ein Team vor der Implementierung.

API-Spezifikationen überprüfen

Prüfen Sie Spezifikationen auf Probleme bei Benennung, Versionierung und Fehlerbehandlung.

API-Benutzerfreundlichkeit verbessern

Verfeinern Sie Endpunkte und Schema, um Client-Verwirrung und Nacharbeit zu reduzieren.

Probiere diese Prompts

REST-Grundlagen-Überprüfung

Überprüfen Sie diese REST-API-Gliederung und listen Sie Korrekturen für Benennung, Methoden und Statuscodes auf. Geben Sie ein kurzes korrigiertes Beispiel.

GraphQL-Schema-Prüfung

Bewerten Sie dieses GraphQL-Schema auf Pagination, Eingabetypen und Fehlermuster. Schlagen Sie Verbesserungen mit kurzen Beispielen vor.

Versionsstrategie

Empfehlen Sie einen Versionsansatz für diese API und erklären Sie die Tradeoffs. Geben Sie eine Migrations-Checkliste.

Design-Checkliste durchführen

Wenden Sie eine API-Design-Checkliste auf diese Spezifikation an und geben Sie Bestanden oder Nicht bestanden mit Korrekturen für jeden fehlgeschlagenen Punkt zurück.