2013-09-05 14 views
38

मैं Express.js का उपयोग करके एक restAPI पर काम कर रहा हूं और मुझे आश्चर्य है कि मेरे लिए एपीआई दस्तावेज जेनरेट करने का कोई तरीका है जो उपयोगकर्ता को एपीआई परिभाषाओं को देखने की अनुमति देता है या संभवतः एपीआई कॉल भी आज़माएं?Node.js या Express.js REST API दस्तावेज़ जनरेटर

उत्तर

24

स्वैगर ऑटो जनरेटिंग एपीआई दस्तावेज के लिए एक अद्भुत परियोजना है। इसमें एक एक्सप्रेस मॉड्यूल शामिल है।

https://developers.helloreverb.com/swagger/

https://github.com/wordnik/swagger-node-express

+0

धन्यवाद। मैं इसे देख रहा हूँ। –

+9

एक्सप्रेस में कॉन्फ़िगर किए गए मार्गों के आधार पर ये ऑटो जनरेट करें? – lostintranslation

+0

@lostintranslation AFAIK वे नहीं करते हैं। Swagger दस्तावेज yml फ़ाइलों में सहेजा गया है। – BillyTom

54

क्या आप देख रहे हैं एक अच्छा जावास्क्रिप्ट प्रलेखन जनरेटर है। मुझे यहां एक सभ्य व्यक्ति मिला है http://apidocjs.com/example/। यह आपको ओप से पूछे जाने वाले एक्सप्रेस का उपयोग करने की अनुमति देगा।

स्वैगर दस्तावेज़ों के लिए नहीं है, यह एपीआई बनाने के लिए है। तो आपको उस सुविधा को पाने के लिए एक पूर्ण प्रणाली सीखने की आवश्यकता होगी।

मैं यहाँ कुछ और पाया कि मैं अभी तक में पूरी तरह से देखा नहीं किया है जो होनहार लग रहे हैं: @dankohn
Docco here JSDoc here और an article on Documentor for Node