2015-03-24 15 views
14

मैंने एक सुंदर विस्तार एपीआई विकसित की है, और मेरे पास पोस्टमैन पर है, जो बहुत अच्छा काम करता है। अब मुझे अपने स्रोतों के साथ संस्करण/दस्तावेज़ों को संस्करणित रखने के लिए एक HTML दस्तावेज़ उत्पन्न करना होगा।पोस्टमैन संग्रह से एचटीएमएल दस्तावेज़ बनाना

क्या यह कोई उपकरण या इसे प्राप्त करने का तरीका है? मैं वास्तव में यह सब दस्तावेज लिखना नहीं चाहता हूं। पोस्टमैन संग्रह साझा करना एक विकल्प नहीं है।

+1

यहां मेरा है, जो पाइथन लिपि के माध्यम से '.md' फ़ाइलों को उत्पन्न करता है https://github.com/Avinash-Raj/docs-from-POSTMAN –

उत्तर

23

मुझे हाल ही में एक ही समस्या थी और मुझे कुछ भी नहीं मिला। तो मैंने इसे करने के लिए एक सरल उपकरण बनाया। यह react.js के साथ लिखा गया एक बहुत ही बुनियादी जावास्क्रिप्ट एप्लिकेशन है। फिलहाल यह बहुत बुनियादी है, लेकिन मैं इस पर काम कर रहा हूं, इसलिए किसी भी सुविधा अनुरोध का स्वागत है।

आपको कम से मुक्त करने के लिए उपयोग कर सकते हैं: http://www.vernizzis.it/docman/

इसके अलावा आप कोड प्राप्त और संशोधित कर सकते हैं: https://github.com/davidevernizzi/docman

कोई भी टिप्पणी का स्वागत करते हैं और अधिक से अधिक है।

Update1: चारों ओर देख मैं भी इस परियोजना पाया: https://github.com/JakeWorrell/docodile और इस सुविधा का अनुरोध: https://github.com/a85/POSTMan-Chrome-Extension/issues/204

UPDATE2: सुविधा का अनुरोध (Update1 देखें) बंद कर दिया गया और प्रलेखन बनाने की संभावना डाकिया बादल में जोड़ा गया है । यहां फीचर अनुरोध बंद करने की सुविधा दी गई है:

यह पोस्टमैन क्लाउड: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/ के हिस्से के रूप में उपलब्ध है। क्लाउड होस्ट करता है, सभी के लिए दस्तावेज अद्यतन करता है और रखता है। संग्रह से एक बार के दस्तावेज उत्पन्न करने के लिए मैं http://docman.launchrock.com/ और https://github.com/JakeWorrell/docodile का सुझाव दूंगा।

+0

अच्छा अच्छा! धन्यवाद ... – mccbala

+0

आपका बहुत स्वागत है। आपका धन्यवाद। –

+5

एक महान परियोजना की तरह लग रहा है। हालांकि यह थोड़ा विडंबना है कि दस्तावेज उत्पन्न करने के लिए एक उपकरण का उपयोग करने के तरीके पर कोई दस्तावेज नहीं है। जब आप कहते हैं कि अपने डाकिया संग्रह को पेस्ट करें तो आपका क्या मतलब है? – Chakaitos

11

मैं जानता हूँ कि यह एक पुराने सवाल है और आप शायद अब तक एक समाधान मिल गया है, लेकिन अभी भी आप Postmanerator द्वारा रुचि हो सकती है: https://github.com/aubm/postmanerator

मूलतः, यह है आप कैसे इसे कमांड लाइन से उपयोग करें:

postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html 

इसे स्थापित करने के लिए, नवीनतम गीथब रिलीज डाउनलोड करें। आपको अपने सिस्टम के आधार पर उपयुक्त बाइनरी चुननी होगी। फिर इसे अपने पैथ में कहीं रखें।

यदि आप अतिरिक्त जानकारी चाहते हैं तो README में दस्तावेज़ देखें। वहां से आपको टूल की पूरी सलाह लेने के लिए सिफारिशें मिलेंगी, या कस्टम थीम का उपयोग करके अपने दस्तावेज़ों को देखें।

गीथब प्रस्तुति भी जेनरेट किए गए उदाहरण दस्तावेज का संदर्भ प्रदान करती है।

आप यह भी पता लगाएंगे कि आप ट्रैविस जैसे सीआई प्लेटफ़ॉर्म का लाभ कैसे उठा सकते हैं, पीढ़ी को स्वचालित करने और पोस्टमेनेटर के साथ अपने दस्तावेज़ों के प्रकाशन को स्वचालित करने के लिए।

चूंकि यह एक ओपन सोर्स प्रोजेक्ट है, मैं वर्तमान में काम कर रहा हूं, तो गिटूब पर मुद्दों को प्रस्तुत करने में संकोच न करें अगर आपके पास कोई विचार है जो इसे बेहतर बना सकता है।

0

आप मेरे द्वारा किए गए मुक्त टूल को भी आजमा सकते हैं। यह .txt में प्रलेखन प्रदान करता है लेकिन आप इसे अपने ब्राउज़र का उपयोग करके पीडीएफ में परिवर्तित कर सकते हैं।

https://postmandoc.herokuapp.com/

0

आप, जहां आदेश "NPM न्यूमैन जी स्थापित" और फिर आदेश "न्युमैन envVar.json -e CollectionName.json चलाने" स्थान से जहां आप अपने संग्रह बचाया है चलाने का उपयोग कर न्यूमैन स्थापित कर सकते हैं CollectionName.json आपका संग्रह नाम है और enVar.json पर्यावरण चर का सेट है। यह एक ही फ़ोल्डर में एचटीएमएल रिपोर्ट उत्पन्न करेगा। एक शर्त है कि नोड जेएस स्थापित हो।

संबंधित मुद्दे