इस प्रोजेक्ट के बारे में
Soenneker.Docker.Hub.OpenApiClient, Docker Hub API के लिए एक Kiota-जनरेटेड .NET क्लाइंट है। इसे NuGet के लिए पैकेज किया गया है और इसे `dotnet add package Soenneker.Docker.Hub.OpenApiClient` के साथ जोड़ा जा सकता है।
एक क्लाइंट बनाने के लिए, README एक `HttpClient` बनाने, Bearer ऑथराइजेशन हेडर सेट करने, `AnonymousAuthenticationProvider` और `HttpClient` के साथ एक `HttpClientRequestAdapter` बनाने, बेस URL को `https://hub.docker.com` पर सेट करने और एडॉप्टर के साथ `DockerHubOpenApiClient` को इंस्टेंटिएट करने का तरीका दिखाता है। यह टोकन को सोर्स कंट्रोल से बाहर रखने और `HttpClient`, एडॉप्टर और जनरेटेड क्लाइंट को पुन: उपयोग करने की सलाह देता है। एक साथी पैकेज, `Soenneker.Docker.Hub.OpenApiClientUtil`, डिपेंडेंसी-इंजेक्शन रजिस्ट्रेशन और कैश्ड कंस्ट्रक्शन प्रदान करता है।
README में `client.V2.AccessTokens.GetAsync` के माध्यम से व्यक्तिगत एक्सेस टोकन को सूचीबद्ध करने, `Page` और `PageSize` क्वेरी पैरामीटर सेट करने और रिस्पॉन्स से `Results` कलेक्शन को पढ़ने का एक उदाहरण शामिल है। पेजिनेशन स्पष्ट है: कॉलर यह तय करने के लिए रिस्पॉन्स से `Next`, `Previous` और `Count` का उपयोग करते हैं कि अगला कौन सा पेज अनुरोध करना है, और क्लाइंट स्वचालित रूप से सभी परिणामों को सूचीबद्ध नहीं करता है।
रिक्वेस्ट बिल्डर्स URL पदानुक्रम का पालन करते हैं, जो `client.V2` से शुरू होते हैं, और कलेक्शन इंडेक्सर्स एक्सेस-टोकन UUID या ऑर्गनाइजेशन नाम जैसे पाथ पैरामीटर प्रदान करते हैं। Kiota प्रलेखित गैर-सफलता रिस्पॉन्स को `ApiException` से व्युत्पन्न जनरेटेड मॉडल में मैप करता है; सटीक त्रुटि प्रकार एंडपॉइंट पर निर्भर करता है। उदाहरण के लिए, एक्सेस टोकन को सूचीबद्ध करना `400` को `ValueError` और `401` को `Error` में मैप करता है। README विफलता को लॉग करते या अनुवाद करते समय उन विवरणों को सुरक्षित रखने और कैंसलेशन को कॉलर तक पहुँचने देने की सिफारिश करता है।
क्लाइंट और मॉडल जनरेटेड हैं, इसलिए README उन्हें सीधे संपादित करने के विरुद्ध चेतावनी देता है क्योंकि पुनरुत्पादन (regeneration) उन परिवर्तनों को बदल देता है। जब Docker Hub का स्पेसिफिकेशन बदलता है, तो एंडपॉइंट नाम, नलैबिलिटी, एरर मैपिंग और मॉडल शेप बदल सकते हैं, इसलिए प्रोडक्शन उपभोक्ताओं को अपग्रेड करने से पहले पैकेज अपडेट की समीक्षा की जानी चाहिए।
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.