API Doc Generator GrapesJS
क्या शामिल है
- डाउनलोड करने और उपयोग करने के लिए निःशुल्क
- व्यक्तिगत और व्यावसायिक उपयोग के लिए खुला
निर्माता का समर्थन करें
इस मुफ्त उत्पाद के लिए निर्माता को धन्यवाद देने के लिए एकमुश्त या मासिक समर्थन का उपयोग करें।
GrapesJS संगत
GrapesJS 0.22.x के साथ परीक्षण किया गया
मुफ्त डाउनलोड
डाउनलोड करें और अपनी परियोजनाओं में मुफ्त में उपयोग करें
संपादक संगत
GrapesJS ओपन-सोर्स संपादक के लिए डिज़ाइन किया गया
उपयोग करने के लिए निःशुल्क
व्यक्तिगत और व्यावसायिक परियोजनाओं के लिए खुला है
GrapesJS एपीआई डॉक प्लगइन
GrapesJS कैनवास पर टेबल और फॉर्म ड्रॉप करें - प्लगइन आपके REST API एंडपॉइंट को स्वचालित रूप से अनुमान लगाता है और एक क्लिक में OpenAPI 3.1, एक पोस्टमैन संग्रह और नकली डेटा उत्पन्न करता है।
क्या अनुमान लगाया जाता है
| कैनवास घटक | अनुमानित समापन बिंदु |
|---|---|
| डेटा तालिका | GET सूची + GET विवरण + PUT अद्यतन + DELETE |
| फॉर्म बनाएं/संपादित करें | POSTPUT + बॉडी स्कीमा का अनुरोध करें |
| खोज बार | क्वेरी पैरामीटर अनुमान |
| ड्रॉपडाउन का चयन करें | एनम मूल्य निष्कर्षण |
| चीनी कॉलम नाम/लेबल | अंग्रेजी फ़ील्ड नाम (300+ मैपिंग) |
एक-क्लिक निर्यात
- ओपनएपीआई 3.1 जेएसओएन
- डाकिया संग्रह JSON (सीधे डाकिया में आयात)
जल्दी शुरू
npm install grapesjs-plugin-apidoc import apiDocPlugin from 'grapesjs-plugin-apidoc'; grapesjs.init({ plugins: [apiDocPlugin] }); कैनवास पर अपना पेज बनाएं → ऊपरी-दाएं पैनल में एपीआई डॉक्स बटन पर क्लिक करें → आपका एपीआई दस्तावेज़ तैयार है।
विकल्प
| विकल्प | प्रकार | डिफ़ॉल्ट | या क़िस्म |
|---|---|---|---|
apiPrefix | string | '/api' | एपीआई पथ उपसर्ग |
btnLabel | string | 'API Docs' | पैनल बटन लेबल |
autoScan | boolean | false | लोड पर स्वचालित रूप से स्कैन करें |
panelId | string | 'options' | बटन को होस्ट करने वाले पैनल की आईडी |
debug | boolean | false | कंसोल में वर्बोज़ स्कैन आउटपुट |
यह काम किस प्रकार करता है
CanvasScanner → TableAnalyzer + FormAnalyzer → APIInferrer → OpenAPI31Generator (component scan) (table / form inference) (dedupe) → PostmanGenerator → MockDataGenerator लाइसेंस
एमआईटी
रेटिंग:
अभी तक कोई समीक्षा नहीं। अपना अनुभव साझा करने वाले पहले व्यक्ति बनें।
प्रश्न एवं उत्तर
अभी तक कोई सवाल नहीं। पूछने के लिए कुछ है?
सामान्य समस्याएं जो यह प्लगइन ठीक करने में मदद कर सकता है
एक ही विषय पर वास्तविक समुदाय के प्रश्न - देखें कि दूसरों ने उनके आसपास कैसे काम किया।