@powerduck/oas-document
React के लिए प्रोडक्शन-स्तरीय OpenAPI दस्तावेज़ कंपोनेंट। OAS दस्तावेज़ देने पर Stripe जैसी पूरी API दस्तावेज़ UI मिलती है, जिसमें हेडर नेविगेशन, हल्की और गहरी थीम, ट्री नेविगेशन, स्क्रॉल ट्रैकिंग, स्कीमा ब्राउज़िंग और कई भाषाओं में कोड उदाहरण शामिल हैं।
- पैकेज का नाम:
@powerduck/oas-document - संस्करण:
- लाइसेंस: MIT
इस्तेमाल की गई लाइब्रेरी: @powerduck/openapi-parser (वैलिडेशन और अपने-आप रूपांतरण), @powerduck/tree (नेविगेशन), @powerduck/md-editor (Markdown रेंडरिंग), @powerduck/openapi-codegen (रिक्वेस्ट कोड बनाना).
सुविधाएँ
- सीधे जोड़ने योग्य API दस्तावेज़ — पार्स किया गया ऑब्जेक्ट, JSON स्ट्रिंग या YAML स्ट्रिं ग स्वीकार करता है
- Stripe जैसा लेआउट — कॉन्फ़िगर किया जा सकने वाला हेडर, साइडबार ट्री और दो-कॉलम ऑपरेशन व्यू
- हल्की और गहरी थीम — हेडर से बदलें; चयन localStorage में सहेजा जाता है
- OAS 3.2 में अपने-आप रूपांतरण —
@powerduck/openapi-parserसे जाँच और रूपांतरण - स्क्रॉल के साथ बदलता नेविगेशन — बाइनरी सर्च वाला पैसिव स्क्रॉल लिसनर
- Markdown रेंडरिंग —
@powerduck/md-editorसे विवरण रेंडर होते हैं - कई भाषाओं में कोड उदाहरण —
@powerduck/openapi-codegenसे बनाए जाते हैं - स्कीमा ब्राउज़िंग — खोली और समेटी जा सकने वाली नेस्टेड प्रॉपर्टी तालिकाएँ
- रिस्पॉन्सिव लेआउट — मोबाइल पर साइडबार ओवरले पैनल बन जाता है