एपीआई एंडपॉइंट

एंडपॉइंट HTTP मेथड और URL पाथ का संयोजन होता है, जिसका जवाब सर्वर देता है: GET /orders और POST /orders एक ही संसाधन पर दो एंडपॉइंट हैं। दस्तावेज़ीकरण, पहुँच नियम, दर सीमाएँ और परीक्षण आमतौर पर प्रत्येक एंडपॉइंट के अनुसार व्यवस्थित किए जाते हैं, यही कारण है कि API का आकार निर्धारित करते समय इसे ही गिना जाता है।

यह काम किस प्रकार करता है

पाथ रिसोर्स का नाम बताता है, पाथ पैरामीटर एक इंस्टेंस ( /orders/{id} ) का चयन करते हैं, क्वेरी स्ट्रिंग परिणाम को सीमित या आकार देती है, और मेथड यह बताती है कि इसके साथ क्या करना है। सर्वर प्रत्येक आने वाले अनुरोध को उस मेथड और पाथ पैटर्न के लिए पंजीकृत हैंडलर को भेजता है, और जो अनुरोध पाथ से मेल खाता है लेकिन मेथड से नहीं, उसका उत्तर 404 के बजाय 405 से दिया जाता है।

गलत धारणा

एक एंडपॉइंट एक यूआरएल होता है। एक ही यूआरएल को अलग-अलग तरीकों से इस्तेमाल करने पर अलग-अलग एंडपॉइंट बनते हैं, जिनके नियम भी अलग होते हैं — जैसे कि GET /orders/7 सार्वजनिक हो सकता है, जबकि DELETE /orders/7 के लिए एडमिन टोकन की आवश्यकता होती है। एक तरीके का परीक्षण करके यह मान लेना कि बाकी तरीके भी वैसे ही काम करेंगे, इसी तरह से प्राधिकरण संबंधी कमियों को समीक्षा से बचाए रखने का तरीका है।

इसे यहाँ आजमाएँ

प्रत्येक दस्तावेज़ पृष्ठ में विधि, पथ और प्रत्येक द्वारा लौटाए जा सकने वाले स्थिति कोड के साथ इसके एंडपॉइंट सूचीबद्ध होते हैं; पिज़्ज़ा एपीआई का DELETE /menu एक ऐसा पथ है जो GET के लिए मौजूद है लेकिन प्रत्येक DELETE का उत्तर 405 देता है।

स्रोत

अन्य शब्द

यह पृष्ठ अंग्रेज़ी में पढ़ें

सभी शब्द · परीक्षण तकनीकें · सभी 39 मॉक REST API

आखरी अपडेट