एपीआई क्लाइंट एसडीके सर्वोत्तम अभ्यास प्रॉम्प्ट

OpenAPI स्पेक से low-level क्लाइंट जनरेट करें, और ऊपर केवल एक पतली, idiomatic परत हाथ से लिखें। विश्वास: 0.85 API स्पेक को सत्य का स्रोत मानें और जब generated कोड पुराना हो जाए तो CI को विफल करें। विश्वास: 0.85 पहली कॉल को तीन लाइनों में संभव बनाएं: install, API key के साथ क्लाइंट बनाएं, एक method कॉल करें। विश्वास: 0.90 API key को डिफ़ॉल्ट रूप से एक जाने-माने environment variable से पढ़ें, और इसे कभी log न करें या error messages में शामिल न करें। विश्वास: 0.95 पूरी तरह से typed request और response models उजागर करें, जिसमें TypeScript types या Python type hints पैकेज में शामिल हों। विश्वास: 0.90 HTTP status, error code, message और request ID के साथ typed errors लौटाएं, बजाय एक generic exception के। विश्वास: 0.90 Idempotent requests को timeouts, 429 और 5xx responses पर exponential backoff और jitter के साथ retry करें, और Retry-After headers का सम्मान करें। विश्वास: 0.90 Retried POST requests पर स्वचालित रूप से idempotency key भेजें जब API इसका समर्थन करता है। विश्वास: 0.80 उचित default timeouts सेट करें और callers को प्रति client और प्रति request timeout और retry settings override करने दें। विश्वास: 0.85 Auto-paginating iterators प्रदान करें ताकि users बिना खुद cursors संभाले सभी results पर loop कर सकें। विश्वास: 0.85 Callbacks के बजाय native async iterators या generators के साथ streaming responses का समर्थन करें। विश्वास: 0.80 उन languages में sync और async दोनों clients प्रदान करें जहां दोनों सामान्य हैं, और समान models साझा करें। विश्वास: 0.75 Runtime dependencies को न्यूनतम रखें और users को किसी विशिष्ट HTTP library version से बांधने से बचें। विश्वास: 0.85 SDK name, version और runtime के साथ User-Agent header भेजें ताकि API owners adoption देख सकें और issues debug कर सकें। विश्वास: 0.80 Semantic versioning का सख्ती से पालन करें और changelog में migration examples के साथ breaking changes का दस्तावेजीकरण करें। विश्वास: 0.90 Minor release में कभी भी method न हटाएं; पहले इसे warning के साथ deprecate करें। विश्वास: 0.85 Speed के लिए recorded HTTP fixtures के खिलाफ test करें और रात में real sandbox environment के खिलाफ एक छोटा suite चलाएं। विश्वास: 0.80 CI में हर supported runtime version पर test suite चलाएं, जैसे प्रत्येक active Node.js LTS या Python release। विश्वास: 0.85 README और docs में runnable code examples रखें, और उन examples को CI में test करें ताकि वे कभी stale न हों। विश्वास: 0.80 Logging, tracing और custom headers के लिए hooks या middleware उजागर करें, बजाय हर आवश्यकता के लिए one-off options जोड़ने के। विश्वास: 0.75 Custom base URL और HTTP client की अनुमति दें ताकि users SDK को proxies, mocks या regional endpoints पर point कर सकें। विश्वास: 0.80 Packages को CI से provenance और signed releases के साथ publish करें, कभी भी maintainer के laptop से नहीं। विश्वास: 0.75