API-Design-Reviewer
PROAuditiere REST- und GraphQL-APIs auf Konsistenz, Skalierbarkeit, Sicherheit und Einhaltung von Best-Practices vor Deployment.
Anwendungsbeispiel
Reviewe mein API-Design (REST) für eine User-Management-API. Prüfe auf Konsistenz, Sicherheitslücken, richtige HTTP-Methoden und Response-Strukturen. Gib konkretes Feedback.
So verwendest du diesen Skill
Skill kopieren mit dem Button oben
In deinen KI-Assistenten einfügen (Claude, ChatGPT, etc.)
Deine Eingaben unten ausfüllen (optional) und kopieren, um sie mit deinem Prompt einzufügen
Absenden und mit der KI chatten beginnen
Anpassungsvorschläge
| Beschreibung | Standard | Dein Wert |
|---|---|---|
| URL to organizational API style guide for validation | https://opensource.zalando.com/restful-api-guidelines/ | |
| Default records per page for pagination review | 20 | |
| Maximum allowed records per request | 1000 | |
| Required authentication mechanism | oauth2 | |
| Maximum allowed GraphQL query complexity score | 1000 | |
| Time window for rate limiting | 3600 |
Audit REST and GraphQL APIs for consistency, scalability, security, and adherence to best practices. Get detailed review reports with actionable recommendations before deployment.
Forschungsquellen
Dieser Skill wurde auf Basis von Forschung aus diesen maßgeblichen Quellen erstellt:
- Enhancing Data Query Flexibility with GraphQL GraphQL vs REST performance characteristics and schema optimization
- REST API Design and Specification Practices Empirical research on real-world API design challenges
- Performance Evaluation of Microservices Communication Benchmark comparing REST, GraphQL, and gRPC performance
- How to Conduct API Design Reviews Practical guide on implementing API review processes
- API Design Patterns for Scalable Systems Resource-based patterns, pagination, and scalability approaches
- GraphQL API Design Best Practices GraphQL-specific schema optimization and error handling
- API Design Reviews Don't Have to be Hard Systematic review methodology and documentation assessment
- OpenAPI Specification v3.1.0 Official machine-readable API description standard