2011-08-24 20 views
5

सर्विसस्टैक बेस वेब सेवाओं को दस्तावेज करने के विकल्प क्या हैं और मैं एक लाइन स्ट्रिंग के बारे में बात नहीं कर रहा हूं।दस्तावेज सेवास्टैक वेब सेवाएं

मैं विस्तार से दस्तावेज़ के लिए, (जो लंबे समय से किया जा सकता है), प्रकार, संभव HTTP प्रतिक्रियाओं लौटने के लिए, विस्तृत उदाहरण जोड़ने आदि

वहाँ ServiceStack में इस के लिए किसी भी समर्थन है सक्षम होने के लिए चाहते हैं (मैं नहीं कर सके ' इसे नहीं मिला)? यदि किसी ने किसी अन्य तरीके से समस्या हल नहीं की है।

उत्तर

4

आप अपने अनुरोध डीटीओ को [एपीआई] और [एपीएमम्बर] विशेषताओं के साथ जिम्मेदार बनाकर अपनी प्रत्येक वेब सेवाओं के लिए मेटाडेटा विवरण प्रदान कर सकते हैं। यह जानकारी गतिशील मेटाडेटा पृष्ठों पर प्रदर्शित की जाएगी।

एक और विकल्प यह है कि आप अपना खुद का गतिशील HTML पृष्ठ बनाएं, जो सर्विसस्टैक आपको केवल एक स्ट्रिंग (अपना एचटीएमएल मार्कअप युक्त) लौटने की अनुमति देता है। यदि आप इस मार्ग पर जाते हैं तो आप वैश्विक प्रकार एंडपॉइंटहोस्ट। सेवाऑपरेशंस संपत्ति के साथ सेवा प्रकार मेटाडेटा तक पहुंच सकते हैं।

इसके अलावा, अगर गतिशील के साथ सी # एचटीएमएल पैदा अपनी पसंद नहीं है तो आप भी का उपयोग कर एचटीएमएल उत्पन्न कर सकते हैं में निर्मित Razor Markdown format जो एचटीएमएल काफी सुखद :)

+0

के लिए स्वैगर समर्थन अब [ApiMember] विशेषता का उपयोग कैसे किया जाता है? मैं देखता हूं कि क्या आप रूट एपीआई पर जाते हैं और डीटीओ का उपयोग करके एंडपॉइंट पर नेविगेट करते हैं, [एपीआई] जानकारी दिखायी जाती है ... लेकिन मुझे नहीं पता था कि [एपीमेम्बर] सामान का उपयोग कहाँ किया जा रहा था। –

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