2012-04-23 11 views
19

रीस्ट एपीआई आसानी से पार्स/जेनरेट/प्रकाशित/प्रकाशित करने के लिए आजकल अच्छे बच्चे क्या हैं? मैंने Swagger पर एक नज़र डाली और यह अच्छा लग रहा है लेकिन मेरे दृष्टिकोण से यह रूबी के साथ ठीक नहीं है। शायद मैं सिर्फ गलत हूं और मुझे कुछ याद आ रहा है, मदद की सराहना की जाएगी।रूबी आधारित आरईएसटी एपीआई दस्तावेज जेनरेट और प्रकाशित करें

+1

बहुत अच्छा लगता है, लेकिन ऐसा लगता है कि –

+0

सेटअप करने के लिए बहुत सारे काम की आवश्यकता है, वास्तव में, यह शानदार लग रहा है लेकिन इसमें निर्भरता का एक टन है जो मैं टालना चाहता हूं। – jpemberthy

उत्तर

14

लगता है जैसे आपके पास अभी तक कोई एपीआई नहीं है? यदि ऐसा है, तो यह वह दृष्टिकोण है जिसे मैं अनुशंसा करता हूं।

  • swagger-specification का उपयोग करके एपीआई के लिए एक इंटरफ़ेस बनाएँ। आप सर्वर, see here का उपयोग किए बिना ऐसा कर सकते हैं।

  • swagger-ui का उपयोग करके इंटरफ़ेस सत्यापित करें। यह आप सभी अंतिमबिंदुओं कि आपके द्वारा निर्धारित देखने के लिए अनुमति देता है (json फ़ाइलों के अलावा अभी भी, कोई कोडिंग,!)

  • एक बार जब आप एक अंतरफलक आप चाहते है, swagger-codegen का उपयोग का एक टोंटदार-आउट संस्करण के निर्माण के लिए अपने सर्वर। वर्तमान में nodejs और scalatra के लिए रास्ते में और अधिक के लिए टेम्पलेट्स हैं। एक नया सर्वर जनरेटर बनाना कुछ मूंछ टेम्पलेट्स बनाने/संशोधित करने का विषय है।

  • आप अपने क्लाइंट को स्वैगर-कोडेजन के साथ भी उत्पन्न कर सकते हैं।

इसकी सुंदरता यह है कि आप अपने एपीआई के इंटरफ़ेस-संचालित विकास कर सकते हैं। इंटरफेस बनाएं और रिक्त स्थान भरें। नलसाजी आपके लिए किया जाता है।

+1

प्रोटोटाइप रूबी समर्थन अब उपलब्ध है (नोट! परिवर्तन अधिक रूबी-आश बनाने के लिए आ जाएगा): https: // github .com/wordnik/swagger-codegen/tree/master/samples/server-generator/sinatra – fehguy

6

स्वैगर ग्राहक के रूप में गहरे लाल रंग का साथ इस्तेमाल किया जा सकता आप आतंक विरोधी का उपयोग करते हैं की तुलना में मुझे लगता है कि आप https://github.com/elc/rapi_doc पर गौर करना चाहिए स्वचालित रूप से एक स्वैगर अनुरूप सर्वर https://github.com/wordnik/swagger-codegen

से क्लाइंट लाइब्रेरी उत्पन्न करने के लिए है, लेकिन यह उपयोग करने के लिए आसान नहीं है।

+0

अरे आपके उत्तर के लिए धन्यवाद, ठीक है, मुझे लगता है कि मैं 'rapi_doc' कोशिश करूंगा। यह स्वैगर के रूप में सेक्सी नहीं दिखता है लेकिन कम से कम इसका सेटअप आसान तरीका है। – jpemberthy

+1

वह rapi_doc लिंक टूटा हुआ है। मैंने पाया कि यह विभिन्न स्थानों पर फोर्क किया गया है उदा। https://github.com/phuc/rapi_doc ऐसा लगता है कि 2008 के बाद से इसे वास्तव में बनाए रखा नहीं गया है हालांकि –

8

हमने अभी इसके लिए apipie के साथ खेलना शुरू कर दिया है। अब तक बहुत साफ दिखता है।

+0

धन्यवाद, आशाजनक लगता है कि मैं इसे भविष्य की परियोजना के लिए ध्यान में रखूंगा। ऐप के लिए पहले से ही स्वैगर का उपयोग कर रहा था, जब मैं सवाल पोस्ट करता था तब मैं बात कर रहा था। – jpemberthy

0

कृपया प्रलेखन के लिए ApiDoco मणि (https://github.com/72pulses/apidoco/) पर एक नज़र डालें। यह सेटअप करना बहुत आसान है और इसका एक अच्छा उपयोगकर्ता अनुभव है।

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