एएसपीनेट वेबएपीआई

Question

के लिए ऑटो जेनरेट प्रलेखन वर्तमान में मेरे पास ASP.Net में एक एमवीसी प्रोजेक्ट है जो वेबएपी का उपयोग कर रहा है। नियंत्रकों के लिए अधिकांश कोड सी # में लिखा गया है। मैं अपने आप सहित API कॉल विवरण उत्पन्न करने के लिए करना चाहते हैं:

1.) पेज/endpoint

2.) क्या endpoint/पेज का विवरण का यूआरएल

3 करता है।) विवरण और डेटाटाइप के साथ तर्कों की सूची।

4.) HTTP क्रिया (प्राप्त, पोस्ट, डाल, हटाने)

5.) अनुमतियाँ पेज

वर्णन के लिए आवश्यक मैन्युअल रूप से लिखा जा करना होगा।

मैंने कुछ अन्य लेख पढ़े हैं जिसके परिणामस्वरूप व्यक्ति तीसरे पक्ष के आवेदन जैसे स्वैगर का उपयोग कर रहा है। क्या इससे मदद करने के लिए एएसपी.Net में कुछ बनाया गया है? अगर मैं खुद को दस्तावेज उत्पन्न करने की कोशिश करना चाहता था (तीसरे पक्ष के सॉफ्टवेयर का उपयोग किए बिना), मैं ऐसे दस्तावेज बनाने पर कैसे शुरू करूं?

मैंने विभिन्न प्रश्नों को गुगल करने में उचित समय बिताया है और मुझे कोई जवाब नहीं मिल रहा है।

संपादित करें: मेरे मामले में ASP.Net सहायता पृष्ठों पर स्वैगर का उपयोग करने का क्या फायदा है?

Answer 1

स्वैगर के विकल्प के रूप में आप एएसपी.नेट वेब एपीआई के लिए 'Help Pages' का उपयोग कर सकते हैं। इस दस्तावेज़ के भीतर

प्रविष्टियां स्वतः उत्पन्न कर रहे हैं और इस तरह के रूप में जानकारी होगी:

• सापेक्ष URI

• HTTP पद्धति

• नमूना अनुरोध/प्रतिक्रिया डेटा

• एक एपीआई उद्देश्य का वर्णन (एक्सएमएल टिप्पणियों से व्युत्पन्न)

तो एक तीसरी पार्टी घटक का उपयोग कर संभव है तो मैं तुम्हें Swagger का उपयोग करें (Swashbuckle NuGet package का प्रयोग करें) API दस्तावेज़ प्राप्त करने के लिए सिफारिश करेंगे।

Answer 2

स्वैगर सिर्फ आपके एपीआई यूरीज़ को सूचीबद्ध नहीं करता है। उपयोगकर्ता वास्तव में उन्हें आज़माते हैं और प्रतिक्रिया

स्वैगर के पास इसे लागू करने से पहले दस्तावेज़ बनाने के लिए टूल हैं।

यह टिप्पणियों का उपयोग करके विवरण भी जोड़ सकता है।