मुख्य कंटेंट तक स्किप करें

Cloud के साथ तुरंत शुरुआत

इस गाइड से आप अपनी मशीन के स्पेसिफिकेशन को साझा किए जा सकने वाले दस्तावेज़ पृष्ठ और MCP एंडपॉइंट में बदल सकते हैं।

1. साइन इन करें​

साइन-इन पृष्ठ पर Google या GitHub से आगे बढ़ें। OAuth प्रमाणीकरण के बाद Powerduck अपना सत्र बनाकर कंसोल खोलता है। एक व्यक्तिगत संगठन अपने-आप बन जाता है।

2. स्पेसिफिकेशन जोड़ें​

डैशबोर्ड से किसी समर्थित स्रोत का इस्तेमाल करके स्पेसिफिकेशन जोड़ें:

  • फ़ाइल अपलोड — OpenAPI फ़ाइल सीधे अपलोड करें;
  • Git रिपॉज़िटरी — रिपॉज़िटरी बताएँ, फिर ब्रांच और फ़ाइल का पाथ चुनें;
  • URL — URL से स्पेसिफिकेशन इम्पोर्ट करें।

मौजूदा OpenAPI 3.0/3.1 और Swagger दस्तावेज़ अपग्रेड किए जाते हैं। cURL या Postman इनपुट को सहेजने से पहले बदलकर उसका प्रीव्यू देखा जा सकता है।

सीधा अपलोड कैसे काम करता है​

बड़ी फ़ाइलें API सर्वर से होकर जाने के बजाय सीधे ऑब्जेक्ट स्टोरेज में अपलोड होती हैं:

  1. एक दस्तावेज़ बनाया जाता है;
  2. ऐप सामग्री का प्रकार और आकार देकर अपलोड URL माँगता है;
  3. पहले से हस्ताक्षरित URL के ज़रिए फ़ाइल सीधे स्टोरेज में अपलोड होती है;
  4. अपलोड पूरा किया जाता है और संस्करण तथा उसका SHA-256 दर्ज होता है।

इससे बड़ी फ़ाइलों का डेटा API सर्वर से होकर नहीं गुजरता।

3. उपलब्ध कराने वाले ऑपरेशन चुनें​

स्पेसिफिकेशन जुड़ जाने पर चुनें कि कौन-से ऑपरेशन सार्वजनिक रूप से उपलब्ध होंगे। हर ऑपरेशन को अलग से चालू या बंद कर सकते हैं; मूल दस्तावेज़ नहीं बदलता। सभी ऑपरेशन से शुरू करें और उन आंतरिक या प्रशासनिक एंडपॉइंट को हटाएँ जिन्हें सार्वजनिक नहीं करना चाहते।

4. लिंक खोलें​

दस्तावेज़ सक्रिय होने पर उसका कार्यक्षेत्र सार्वजनिक पते दिखाता है:

  • दस्तावेज़ — सार्वजनिक व्यूअर में तैयार API दस्तावेज़;
  • MCP — प्रबंधित Streamable HTTP MCP एंडपॉइंट;
  • मूल स्पेसिफिकेशन डेटा भी एक स्थिर URL पर उपलब्ध रहता है।

डिफ़ॉल्ट रूप से दस्तावेज़ चालू रहते हैं और पासवर्ड जोड़ने पर ही सुरक्षित होते हैं। MCP की उपलब्धता और उसकी ऐक्सेस कुंजी अलग से सेट की जाती है।

5. ज़रूरत हो तो ऐक्सेस सुरक्षित करें​

  • दस्तावेज़ देखने के लिए पासवर्ड जोड़ें और चाहें तो उसकी समय-सीमा तय करें;
  • MCP एंडपॉइंट के लिए MCP ऐक्सेस कुंजी बनाएँ;
  • दोनों को अस्थायी रूप से ऑफ़लाइन करने के लिए दस्तावेज़ रोक दें।

6. नए संस्करणों के साथ आगे बढ़ें​

API बदलने पर पुराना संस्करण बदलने के बजाय नई सामग्री को नए संस्करण के रूप में अपलोड करें। साझा लिंक वर्तमान दस्तावेज़ या किसी निश्चित संस्करण की ओर जा सकते हैं। निश्चित संस्करण से जुड़ा लिंक पाठक के लिए अपनी सामग्री नहीं बदलता।

अगले कदम​