OData एंडपॉइंट्स (swagger, swashbuckle, अन्य) को कैसे दस्तावेज़ित करें?

Question

ओडाटा एंडपॉइंट्स को दस्तावेज करने का सबसे अच्छा तरीका क्या है? क्या इसके लिए स्वाशबकल का उपयोग करने का कोई तरीका है?

Answer 1

हाँ, हम YAML है जैसे कि यह समर्थन करने के लिए कोशिश कर रहे हैं -> अकड़, YAML - ..> CSDL

लेकिन यह कार्यान्वयन करने के लिए समय की आवश्यकता होगी, तो आप एक प्रोटोटाइप देख सकते हैं और वहाँ पर नज़र रखने के https://github.com/OData/model-first

Answer 2

मैं वास्तव में स्वाशबकल के भीतर IDocumentFilter फ़ंक्शन का उपयोग करके इसके लिए कुछ काम कर रहा है। मैंने स्वाशबकल के लिए गिटहब रेपो पर एक समान प्रश्न का उत्तर दिया। यहाँ मेरी प्रतिक्रिया की जाँच करें (यह नीचे या नीचे की ओर या तो है):

https://github.com/domaindrivendev/Swashbuckle/issues/149

मैं एक काम कर IDocumentFilter कार्यान्वयन है कि आप अपने OData endpoint स्वैगर ui में सेट करने के लिए लाभ उठाने का एक उदाहरण पोस्ट किया है ।

Answer 3

हां, Swashbuckle.OData आज़माएं। यह ओडाटा कंट्रोलर के लिए स्वाशबकल समर्थन को जोड़ता है।

इसे यहां कार्रवाई में देखें: http://swashbuckleodata.azurewebsites.net/swagger