2015-02-07 15 views
10

के लिए हेल्पपेज मैं वर्तमान में विजुअल स्टूडियो 2015 पूर्वावलोकन में एएसपीनेट vnext एमवीसी 6 की जांच कर रहा हूं। मैं सामान्य रूप से एएसपीनेट के लिए काफी नया हूं, लेकिन मेरी कंपनी के भीतर हम अपने सर्वर पर डेटा तक पहुंचने के लिए एएसपीनेट का उपयोग करके एक वेब एपीआई बनाने की दिशा में आगे बढ़ने जा रहे हैं (वर्तमान में हम केवल अपने स्वयं के चांदी के आवेदन के साथ डब्ल्यूसीएफ संचार का समर्थन करते हैं)। यही वजह है कि मैं एमवीसी 6 की नई कार्यक्षमताओं की जांच कर रहा हूं कि यह निर्णय लेने के लिए कि क्या हमें अपना विकास शुरू करने से पहले इंतजार करना चाहिए और अंत में रिलीज होने पर या एमवीसी 6 का उपयोग करना चाहिए और अब वेब एपीआई 2 प्रोजेक्ट बनाना है।एएसपी.NET vNext एमवीसी 6 वेब एपी

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

अब मेरे प्रश्न के लिए, एमवीसी 6 के लिए यह कुछ उपलब्ध है? मैं अपने प्रोजेक्ट.जेसन में अपने एएसपी.नेट वीएनएक्स्ट/एमवीसी 6 (जो भी आप इसे कॉल करना चाहते हैं) में एक ही पैकेज आयात कर सकते हैं, लेकिन मैं अपनी स्टार्टअप सीएस फाइल में app.UseHelpPage(); नहीं कर सकता।

मुझे संदेह है कि यह अभी तक वर्तमान रिलीज में एकीकृत नहीं है (अभी तक)। यदि नहीं, तो क्या एएसपी.NET vNext अंततः शेल्फ को हिट करने के बाद इस सुविधा के एकीकरण के बारे में कुछ भी पता है?

उत्तर

4

शायद यह सुविधा अभी तक एमवीसी 6 में उपलब्ध नहीं है, लेकिन आप स्वैगर को आजमा सकते हैं। स्वैगर मूल रूप से रीस्टफुल एपीआई का वर्णन, उपभोग करने और विज़ुअलाइज़ करने के लिए एक ढांचा है। स्वाशबकल के बारे में अच्छी बात यह है कि इसकी एएसपी.नेट एमवीसी पर कोई निर्भरता नहीं है, इसलिए एपीआई दस्तावेज को सक्षम करने के लिए किसी भी एमवीसी नुजेट पैकेज को शामिल करने की आवश्यकता नहीं है, साथ ही स्वाशबकल में swagger-ui का एम्बेडेड वर्जन है जो स्वचालित रूप से सेवा करेगा एक बार Swashbuckle स्थापित है।

स्रोत: http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/

+0

टिप के लिए धन्यवाद, मैं यह ध्यान में रखना होगा! जैसा कि यह अभी भी खड़ा है, यह एमवीसी 6 के साथ भी काम नहीं करता है। मुझे लगता है कि ऐसा करना है क्योंकि एमवीसी 6 प्रोजेक्ट एक .csproj के बजाय एक .kproj है, स्वाशबकल के लिए nuget पैकेज स्थापित होने पर त्रुटि देता है। – Maarten

+0

यह एएसपी.NET v6 में काम करने का एक तरीका है: http://devmeetsbi.ghost.io/help-and-test-page-for-asp-net-web-api-asp-net-5-and -एमवीसी -6/ –

+0

यदि आपका एपीआई आराम से नहीं है, तो यह ठीक से काम नहीं कर रहा है, हालांकि। मैं नहीं कहूंगा कि यह एक वैध जवाब है क्योंकि यह केवल आंशिक रूप से आपकी मदद करेगा। जब आप कस्टम कमांड या मॉडल/एक्शन बाइंडिंग का उपयोग करते हैं, या यदि आप आरईएसटी नहीं बना रहे हैं लेकिन एक और आरपीसी-जैसी आधारित एपीआई है तो यह काम नहीं करेगा क्योंकि स्वैगर की बहुत राय है। –

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