पाठ्यक्रम 148 में से पाठ 67 · APIs जिनका कोई ग़लत इस्तेमाल नहीं कर सकता
APIs जिनका कोई ग़लत इस्तेमाल नहीं कर सकता

डिज़ाइन से ग़लत इस्तेमाल

यह क्यों मायने रखता है एक API सीमा पर ज़्यादातर bugs API में नहीं होते। वे एक ऐसे caller में होते हैं जिसने उसे इस तरह इस्तेमाल किया जो ठीक दिखा और चुपचाप ग़लत काम किया। आप हर caller को ठीक नहीं कर सकते; आप ग़लत इस्तेमाल को असंभव, या ज़ोरदार, बना सकते हैं।

एक API लिखने वाला assistant मददगार होने की ओर झुकता है: अगर आप connect करने से पहले भेजें, तो यह आपके लिए connect करता है; अगर आप bytes की जगह एक string दें, तो यह उसे encode करता है; अगर आप एक विकल्प भूलें, तो एक default है। हर मेहरबानी एक ग़लती को तब तक छिपाती है जब तक वह कहीं दूर सामने न आए।

जल्दी विफल, ज़ोर से विफल: ठीक उस call पर एक त्रुटि raise करें जो ग़लत है, कुछ भी बदलने से पहले, एक संदेश के साथ जो बताए कि क्या अपेक्षित था।

चार औज़ार

  • स्पष्ट states: एक object जो जानता है कि वह नया, खुला या बंद है, और फ़िट न होने वाली calls मना करता है।
  • नाम वाले विकल्प, कोई booleans नहीं: mode="dry_run" ग़लती से दूसरे flag से नहीं बदला जा सकता; copy(a, b, True, False) बदला जा सकता है।
  • कोई चुप defaults नहीं उन चुनावों के लिए जिन्हें ग़लत पाना ख़तरनाक है: caller से कहलवाएँ।
  • अर्थ ले जाने वाले types: अपनी मुद्रा जानने वाला पैसा दूसरी मुद्रा के पैसे में नहीं जोड़ा जा सकता।

इस module में, छिपी ग़लत-इस्तेमाल scripts आपके API को ग़लत तरह बुलाती हैं और ग़लत call पर एक त्रुटि की उम्मीद करती हैं, कुछ बदले बिना। सही-इस्तेमाल scripts उम्मीद करती हैं कि यह बस काम करे। हर समस्या उन ग़लत इस्तेमालों को सूचीबद्ध करती है जिनसे बचाना है।

सार मददगार अनुमान bugs छिपाते हैं। ग़लत इस्तेमाल को उसी call पर मना करें जो ग़लत है, किसी भी असर से पहले।

इस पाठ में कोई समस्या दिखी? बताएँ · इस पाठ के बारे में पूछें

यह अभ्यास जल्द खुलेगा

इससे पहले वाला पाठ पूरा करें और यह खुल जाएगा। पूरा कोर्स मुफ़्त है, कोई खाता नहीं चाहिए, और आप यह पाठ अभी पढ़ सकते हैं।