backend-api
RESTful-APIs mit Best Practices entwerfen
또한 다음에서 사용할 수 있습니다: EIS-ITS
Die Erstellung von APIs erfordert sorgfältige Aufmerksamkeit für Routing, Versionierung und HTTP-Standards, um Wartbarkeit und Benutzerfreundlichkeit zu gewährleisten. Diese Anleitung bietet Expertenrat zur Erstellung sauberer, gut strukturierter APIs, die den Branchenbest Practices folgen.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"backend-api" 사용 중입니다. Create a users API with pagination and filtering
예상 결과:
- GET /api/v1/users - List all users with optional filters (page, limit, sort, search)
- GET /api/v1/users/{id} - Retrieve single user by ID
- POST /api/v1/users - Create new user with validation
- PUT /api/v1/users/{id} - Update user completely
- PATCH /api/v1/users/{id} - Update user partially
- DELETE /api/v1/users/{id} - Remove user
- Response includes: data array, meta object with pagination info, links for navigation
- Rate limit: 60 requests per minute with X-RateLimit headers
"backend-api" 사용 중입니다. How should I version my API?
예상 결과:
- URL Path Versioning (/api/v1/users): Simpler to implement and discover. Easy to route different versions.
- Header Versioning (Accept: application/vnd.api.v1+json): Keeps URLs clean but requires more client setup.
- Recommendation: Start with URL path versioning for most projects. Migrate to header-based when needed.
보안 감사
안전This is a pure documentation skill containing only markdown guidance and JSON metadata. No executable code, no network operations, no filesystem modifications. All 38 static findings are false positives triggered by benign text patterns in documentation. The skill only provides API design guidance and does not access, store, or transmit any data.
위험 요인
🌐 네트워크 접근 (1)
📁 파일 시스템 액세스 (4)
⚙️ 외부 명령어 (4)
품질 점수
만들 수 있는 것
API-Endpunkte erstellen
Neue RESTful-API-Endpunkte nach Branchenstandards und Best Practices entwerfen und implementieren.
Vorhandene APIs warten
Vorhandene API-Routen und Controller mit konsistenten Mustern erweitern oder refaktorieren.
API-Strategie entwerfen
API-Versionsstrategien und Antwortformatierungsansätze für neue Projekte planen.
이 프롬프트를 사용해 보세요
Erstelle einen RESTful-API-Endpunkt für die Verwaltung von [resource_name]. Binde korrektes Routing, Controller-Methoden für CRUD-Operationen und geeignete HTTP-Statuscodes ein.
Füge Paginierungsunterstützung zum vorhandenen [endpoint_name] API-Endpunkt hinzu. Binde Abfrageparameter für Seitennummer und Limit ein, mit korrekten Antwortmetadaten.
Implementiere API-Versionalisierung für [api_name]. Sollte ich URL-Pfad-Versionalisierung (/api/v1/) oder Header-basierte Versionierung verwenden? Biete Konfigurations- und Migrationsschritte.
Füge Rate-Limiting zum [endpoint_name] API-Endpunkt hinzu. Konfiguriere geeignete Limits pro Benutzer und binde Rate-Limit-Header in Antworten ein.
모범 사례
- Konsistente URL-Namenskonventionen verwenden (Pluralformen für Ressourcen, Kebab-Case)
- Immer geeignete HTTP-Statuscodes zurückgeben (200, 201, 400, 404, 422, 500)
- Paginierungsmetadaten und Rate-Limit-Header in allen Listen-Endpunkten einfügen
피하기
- Verwendung von Verben in URLs anstelle von Substantiven (z.B. /getUsers statt /users)
- Zurückgeben unterschiedlicher Antwortstrukturen für Erfolgs- und Fehlerfälle
- Offenlegen interner Datenbank-IDs in API-Antworten; stattdessen UUIDs verwenden