API Design रिव्यूअर
PRODeployment से पहले REST और GraphQL APIs को consistency, scalability, security, और best practices adherence के लिए audit करो।
उपयोग का उदाहरण
User management service के लिए यह REST API design review करो। Endpoint: GET /api/v1/users/{id}/profile। RESTful naming conventions, HTTP status codes, और error responses check करो।
स्किल प्रॉम्प्ट
यह skill सबसे अच्छा तब काम करता है जब इसे findskill.ai से कॉपी किया जाए — इसमें variables और formatting शामिल हैं जो कहीं और से सही ढंग से transfer नहीं हो सकते।
इस स्किल का उपयोग कैसे करें
1
स्किल कॉपी करें ऊपर के बटन का उपयोग करें
2
अपने AI असिस्टेंट में पेस्ट करें (Claude, ChatGPT, आदि)
3
नीचे अपनी जानकारी भरें (वैकल्पिक) और अपने प्रॉम्प्ट में शामिल करने के लिए कॉपी करें
4
भेजें और चैट शुरू करें अपने AI के साथ
सुझाया गया कस्टमाइज़ेशन
| विवरण | डिफ़ॉल्ट | आपका मान |
|---|---|---|
| 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.
शोध स्रोत
यह स्किल इन विश्वसनीय स्रोतों से शोध का उपयोग करके बनाया गया था:
- 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