📦

api-patterns

Name: api-patterns
Author: sickn33

Sûr

Bessere APIs mit Musteranleitungen entwerfen

Der Aufbau von APIs ohne klare Designprinzipien führt zu inkonsistenten Schnittstellen und einer schlechten Developer Experience. Diese Skill bietet Entscheidungsbäume und Best Practices für die Auswahl des richtigen API-Stils und dessen korrekte Implementierung.

Prend en charge: Claude Codex Code(CC)

🥉 75 Bronze

Télécharger le ZIP du skill

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

Activez et commencez à utiliser

Tester

Utilisation de "api-patterns". Sollte ich REST oder GraphQL für eine mobile App mit komplexen Datenbeziehungen verwenden?

Résultat attendu:

GraphQL ist für Ihren Anwendungsfall besser geeignet, weil: 1) Mobile Apps von flexiblen Queries profitieren, um Over-Fetching zu reduzieren, 2) Mehrere Frontend-Plattformen genau das anfordern können, was sie benötigen, 3) Komplexe Daten-Graphen sich natürlich auf GraphQL-Schemata abbilden lassen. Erwägen Sie GraphQL jedoch nur, wenn Ihr Team damit vertraut ist und Sie die Infrastruktur für Query-Kostenanalyse haben.

Utilisation de "api-patterns". Welche HTTP-Statuscodes sollte ich für einen POST-Endpunkt verwenden, der einen Benutzer erstellt?

Résultat attendu:

Verwenden Sie 201 Created für erfolgreiche Benutzererstellung, 400 Bad Request für ungültige Eingaben, 409 Conflict wenn die E-Mail bereits existiert, und 500 für Serverfehler. Fügen Sie den erstellten Benutzer im Response-Body hinzu und setzen Sie den Location-Header auf die URI der neuen Ressource.

Audit de sécurité

Sûr

v1 • 2/24/2026

All 67 static findings are false positives. The skill is a documentation resource for API design patterns. Backticks detected are markdown code formatting, not shell commands. No weak cryptography or reconnaissance tools present.

Fichiers analysés

735

Lignes analysées

résultats

Total des audits

Problèmes à risque moyen (1)

api-style.md:7-24 graphql.md:7-41 trpc.md:7-41 rest.md:7-14

Markdown Code Blocks Flagged as Shell Commands

Static analyzer detected backticks in markdown files and flagged them as 'Ruby/shell backtick execution'. These are documentation code blocks for API decision trees and examples, not actual shell commands.

Problèmes à risque faible (1)

rest.md:34-38 security-testing.md:59 security-testing.md:102

HTTP Status Code Terms Flagged as Reconnaissance

Security testing documentation mentions standard HTTP status codes (401 Unauthorized, 403 Forbidden) and SSRF testing concepts. These are legitimate API security education topics, not reconnaissance tools.

Audité par: claude

Score de qualité

Architecture

100

Maintenabilité

Contenu

Communauté

Sécurité

Conformité aux spécifications

Ce que vous pouvez construire

API-Architektur auswählen

Entwickler startet ein neues Projekt und muss basierend auf dem Frontend-Stack und der Datenkomplexität zwischen REST, GraphQL oder tRPC entscheiden.

REST-Endpunkte entwerfen

Team implementiert eine REST-API und benötigt Anleitung für Resource-Naming, HTTP-Methoden und korrekte Statuscode-Verwendung.

API-Sicherheitsprüfung

Sicherheitsingenieur auditiert bestehende APIs auf häufige Schwachstellen mithilfe der OWASP API Top 10 Checkliste.

Essayez ces prompts

API-Stil-Auswahl

Ich entwickle ein [beschreiben Sie Ihr Projekt, z.B. E-Commerce-App mit React-Frontend und Node.js-Backend]. Welchen API-Stil sollte ich verwenden? Was sind die Trade-offs?

REST-Endpunkt-Design

Ich muss REST-Endpunkte für [beschreiben Sie die Ressource, z.B. Benutzerverwaltung mit Profilen, Beiträgen und Kommentaren] entwerfen. Zeigen Sie mir die richtige URL-Struktur, HTTP-Methoden und Statuscodes.

API-Fehlerbehandlung

Was ist der beste Weg, Fehler in meiner API zu behandeln? Zeigen Sie mir das richtige Antwortformat und welche HTTP-Statuscodes für [Liste der Fehlerszenarien] verwendet werden sollen.

API-Versionierungsstrategie

Wie sollte ich meine API versionieren? Ich erwarte, dass sich die API im Laufe der Zeit weiterentwickelt. Vergleichen Sie URI-Versionierung, Header-Versionierung und Query-Parameter-Versionierung.

Bonnes pratiques

Wählen Sie den API-Stil basierend auf Client-Anforderungen, nicht nach persönlicher Präferenz - berücksichtigen Sie Frontend-Stack, Datenkomplexität und Caching-Anforderungen
Verwenden Sie konsistente Response-Envelopes und Standard-Fehlerformate über alle Endpunkte hinweg
Implementieren Sie Rate Limiting von Anfang an und kommunizieren Sie Limits klar in der API-Dokumentation

Éviter

Verben in REST-Endpunkten verwenden (z.B. /getUsers statt GET /users)
Unterschiedliche Antwortformate für dieselbe Ressource über verschiedene Endpunkte zurückgeben
Interne Fehlermeldungen und Stack Traces an API-Clients exponieren

Foire aux questions

Wann sollte ich REST gegenüber GraphQL bevorzugen?

Wählen Sie REST für öffentliche APIs, die breite Kompatibilität benötigen, einfache CRUD-Operationen oder wenn HTTP-Caching wichtig ist. Wählen Sie GraphQL für komplexe Datenbeziehungen, mehrere Frontend-Plattformen oder wenn Clients flexible Queries benötigen.

Was ist die beste API-Versionierungsstrategie?

URI-Versionierung (z.B. /v1/users) ist am gebräuchlichsten und sichtbarsten. Header-Versionierung ist sauberer, aber weniger entdeckbar. Query-Versionierung (z.B. /users?version=1) funktioniert für kleinere Änderungen, kann aber URLs unübersichtlich machen.

Wie sollte ich Paginierung in meiner API handhaben?

Verwenden Sie Cursor-basierte Paginierung für große Datensätze und Infinite Scroll. Verwenden Sie Offset-basierte Paginierung für bekannte Seitengrößen. Fügen Sie die Gesamtanzahl hinzu, wenn nützlich, und stellen Sie next/previous-Links in der Antwort bereit.

Was ist der Unterschied zwischen den Statuscodes 401 und 403?

401 Unauthorized bedeutet, dass die Authentifizierung fehlt oder ungültig ist. 403 Forbidden bedeutet, dass die Authentifizierung gültig ist, der Benutzer jedoch keine Berechtigung für die angeforderte Ressource hat.

Sollte ich JWT oder session-basierte Authentifizierung verwenden?

JWT ist besser für stateless APIs und Microservices. Session-basierte Authentifizierung funktioniert gut für traditionelle serverseitig gerenderte Apps. Berücksichtigen Sie Ihre Skalierungsanforderungen und Client-Typen.

Wie schütze ich meine API vor häufigen Angriffen?

Implementieren Sie Rate Limiting, validieren Sie alle Eingaben, verwenden Sie parametrisierte Queries, implementieren Sie ordnungsgemäße Autorisierungsprüfungen (BOLA), deaktivieren Sie Introspection in Production und befolgen Sie die OWASP API Top 10-Richtlinien.