2015-09-30 11 views
9

मैं माइक्रोसॉफ्ट स्टैक से परिचित हूं। मैं अपनी कुछ आरामदायक सेवाओं के लिए ओडाटा का उपयोग कर रहा हूं। हाल ही में मैं एपीआई दस्तावेज के लिए स्वैगर में आया और मैं यह समझने की कोशिश कर रहा हूं कि यह ओडाटा से कैसे संबंधित है। उनमें से दोनों रीस्टफुल विनिर्देशों के रूप में प्रतीत होते हैं। किसका व्यापक रूप से उपयोग किया जाता है?स्वैगर क्या है और क्या यह ओडाटा से संबंधित है?

उत्तर

20

स्वैगरदस्तावेज एपीआई के लिए एक विनिर्देश है। अपने एपीआई के लिए एक स्वैगर दस्तावेज़ बनाकर, आप इसे स्वैगर यूआई के उदाहरण में पास कर सकते हैं, जो दस्तावेज़ को एक साफ, पठनीय प्रारूप में प्रस्तुत करता है और आपके एपीआई को आमंत्रित करने के लिए टूलिंग प्रदान करता है। अधिक जानकारी के लिए swagger.io वेबसाइट देखें।

OData http से अधिक डाटा सेवाओं बनाने के लिए एक विनिर्देश है, यह परिभाषित करता है कि कैसे एक सेवा का निर्माण किया जाना चाहिए और क्या पैटर्न यह पालन करना चाहिए। उदाहरण के लिए, डेटा सेट के पहले एन परिणाम प्रदान करने के लिए $ शीर्ष निर्देश का उपयोग। ओडाटा वर्तमान में संस्करण 4 पर है, लेकिन v2 दस्तावेज़ में very good overview है।

माइक्रोसॉफ्ट के लिए Swashbuckle is a nuget package ढेर कि कोड और अतिरिक्त मेटाडेटा आप उत्पादन दस्तावेज़ को आकार प्रदान निरीक्षण के आधार पर, अपने एपीआई स्वचालित रूप से के लिए अकड़ दस्तावेजों पैदा करता है।

आप Swashbuckle स्वचालित रूप से एक OData एपीआई आप निर्माण कर रहे हैं के लिए अकड़ दस्तावेजों उत्पन्न करने के लिए चाहते हैं, तो आप का उपयोग Swashbuckle.OData आप के लिए यह प्रदान करने के लिए कर सकते हैं।

मुझे आशा है कि इससे कोई भ्रम दूर हो जाएगा।

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