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

ओपन सोर्स लाइब्रेरी

Powerduck छोटे, आपस में जोड़े जा सकने वाले npm पैकेज से बना है। डेस्कटॉप क्लाइंट और क्लाउड सेवा उन्हीं लाइब्रेरी का उपयोग करते हैं, इसलिए समान घटक स्थानीय रूप से, नेटवर्क पर या आपके अपने टूल में चल सकते हैं।

हर पैकेज स्वतंत्र रूप से प्रकाशित होता है और उसकी अपनी इंस्टॉलेशन गाइड, API संदर्भ और उदाहरण हैं। यह पृष्ठ उनके काम और आपसी संबंध समझाता है।

लेयर संरचना​

Powerduck / Cloud
↓
एम्बेड करने योग्य UI
↓
वर्कफ़्लो
↓
आधार

पार्सर और कन्वर्टर आधार बनाते हैं। उनके ऊपर वर्कफ़्लो और सबसे ऊपर एम्बेड करने योग्य UI होता है। हर पैकेज में पार्सिंग फिर से बनाने के बजाय साझा आधार इस्तेमाल करने से व्यवहार सुसंगत रहता है।

पैकेज​

आधार​

पैकेजउपयोग
@powerduck/openapi-parserOpenAPI/Swagger दस्तावेज़ पार्स, वैलिडेट और अपग्रेड करना
@powerduck/conf-patchसंरचित और वैलिडेट किए गए कॉन्फ़िगरेशन पैच लागू करना
@powerduck/x-to-openapicURL और Postman जैसे फ़ॉर्मैट को OpenAPI में बदलना

वर्कफ़्लो​

पैकेजउपयोग
@powerduck/openapi-cliसिनेरियो रन सहित मल्टी-प्रोटोकॉल कमांड-लाइन वर्कफ़्लो
@powerduck/openapi-codegenस्पेसिफ़िकेशन से क्लाइंट कोड और अन्य आउटपुट बनाना
@powerduck/openapi-mcp-serverOpenAPI स्पेसिफ़िकेशन को MCP सर्वर के रूप में उपलब्ध कराना
@powerduck/openapi-requestस्पेसिफ़िकेशन में बताई गई रिक्वेस्ट चलाना

एम्बेड करने योग्य UI​

पैकेजउपयोग
@powerduck/oas-documentReact एंट्री सहित OpenAPI को पढ़ने योग्य दस्तावेज़ के रूप में दिखाना
@powerduck/md-editorएम्बेड करने योग्य Markdown एडिटर
@powerduck/schema-editorएम्बेड करने योग्य JSON Schema एडिटर
@powerduck/treeसंरचित डेटा के लिए ट्री कंपोनेंट
@powerduck/workspace-yamlवर्कस्पेस YAML इंटीग्रेशन

सही पैकेज चुनना​

  • OpenAPI फ़ाइल पढ़ना, वैलिडेट या अपग्रेड करना: openapi-parser से शुरू करें।
  • cURL या Postman कलेक्शन को OpenAPI में बदलना: x-to-openapi इस्तेमाल करें।
  • कमांड लाइन या CI से सिनेरियो या मल्टी-प्रोटोकॉल वर्कफ़्लो चलाना: openapi-cli इस्तेमाल करें।
  • क्लाइंट कोड बनाना: openapi-codegen इस्तेमाल करें।
  • AI एजेंट को API टूल के रूप में देना: openapi-mcp-server इस्तेमाल करें।
  • React ऐप में रेंडर किया गया दस्तावेज़ जोड़ना: oas-document की React एंट्री और CSS इस्तेमाल करें।
  • एडिटर जोड़ना: md-editor या schema-editor इस्तेमाल करें।

एजेंट के साथ क्षमताएँ साझा करना​

MCP सर्वर पैकेज से बाहरी AI एजेंट भी Powerduck की क्षमताएँ इस्तेमाल कर सकते हैं। openapi-mcp-server के माध्यम से उपलब्ध स्पेसिफ़िकेशन अपने ऑपरेशन MCP टूल के रूप में देता है। इसलिए दस्तावेज़ और कोड जनरेशन में इस्तेमाल होने वाला वही कॉन्ट्रैक्ट एजेंट सीधे कॉल कर सकता है। डेस्कटॉप क्लाइंट, Cloud और अन्य MCP-संगत टूल एक ही आधिकारिक परिभाषा साझा करते हैं।

उदाहरणों के बारे में​

कोड उदाहरण पैकेज के वास्तविक API के अनुसार लिखे गए हैं और दिखाए गए रूप में चलाने के लिए हैं। पैकेज अपग्रेड होने पर पुराने संस्करणों का कोड कॉपी करने के बजाय मौजूदा पैरामीटर के लिए रिलीज़ नोट देखें।

हर पैकेज की इंस्टॉलेशन, कॉन्फ़िगरेशन और पूरे API संदर्भ के लिए साइडबार का उपयोग करें।