REST API एंडपॉइंट
Caution
डेमो पेज - यह एक डेमो पेज है, जो मल्टी-टैब दस्तावेज़ीकरण सुविधा को दिखाता है. यह सामग्री केवल उदाहरण के तौर पर है.
हमारा REST API डेटा तक पहुँचने और उसमें बदलाव करने के लिए एंडपॉइंट देता है. सभी एंडपॉइंट डेटा JSON फ़ॉर्मैट में लौटाते हैं.
बेस URL
सभी API रिक्वेस्ट इस बेस URL पर भेजी जानी चाहिए:
https://api.example.com/v1Users एंडपॉइंट
सभी उपयोगकर्ता प्राप्त करें
GET /usersसभी उपयोगकर्ताओं की सूची लौटाता है. पेजिनेशन पैरामीटर समर्थित हैं.
क्वेरी पैरामीटर:
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
| page | integer | पेज नंबर (डिफ़ॉल्ट: 1) |
| limit | integer | प्रति पेज रिकॉर्ड की संख्या (डिफ़ॉल्ट: 50, अधिकतम: 100) |
| sort | string | सॉर्ट करने के लिए फ़ील्ड (उदाहरण: “name”, “created_at”) |
रिस्पॉन्स:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}ID से उपयोगकर्ता प्राप्त करें
GET /users/{id}ID के आधार पर एक उपयोगकर्ता लौटाता है.
रिस्पॉन्स:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Products एंडपॉइंट
सभी प्रोडक्ट प्राप्त करें
GET /productsसभी प्रोडक्ट की सूची लौटाता है. फ़िल्टरिंग और पेजिनेशन समर्थित हैं.
क्वेरी पैरामीटर:
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
| category | string | श्रेणी के आधार पर फ़िल्टर करें |
| min_price | number | न्यूनतम कीमत के आधार पर फ़िल्टर करें |
| max_price | number | अधिकतम कीमत के आधार पर फ़िल्टर करें |
| page | integer | पेज नंबर (डिफ़ॉल्ट: 1) |
| limit | integer | प्रति पेज रिकॉर्ड की संख्या (डिफ़ॉल्ट: 50, अधिकतम: 100) |
रिस्पॉन्स:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}एरर हैंडलिंग
सभी एंडपॉइंट मानक HTTP स्टेटस कोड का पालन करते हैं और ज़रूरत पड़ने पर विस्तृत एरर मैसेज देते हैं:
| स्टेटस कोड | विवरण |
|---|---|
| 200 | OK - रिक्वेस्ट सफल रही |
| 400 | Bad Request - अमान्य पैरामीटर |
| 401 | Unauthorized - प्रमाणीकरण ज़रूरी है |
| 403 | Forbidden - अपर्याप्त अनुमतियाँ |
| 404 | Not Found - संसाधन मौजूद नहीं है |
| 429 | Too Many Requests - रेट लिमिट पार हो गई |
| 500 | Internal Server Error - सर्वर एरर हुआ |
एरर रिस्पॉन्स में एक मैसेज होता है, जो बताता है कि क्या गड़बड़ हुई:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}