नियंत्रक पर एक्सएमएल टिप्पणियों का उपयोग करते हुए एएसपी.नेट वेब एपीआई सहायता पृष्ठ प्रलेखन

Question

मैंने ASP.NET Web API Help Page पैकेज स्थापित किया है और पहले से ही एक्सएमएल टिप्पणियों का उपयोग करके मेरे एपीआई नियंत्रक कार्यों के लिए प्रलेखन जेनरेट करने के लिए इसका उपयोग करना चाहता हूं।

मैं article on Yao's MSDN blog पर आया जहां उन्होंने चर्चा की कि XML टिप्पणियों के आधार पर दस्तावेज़ कैसे उत्पन्न किया जा सकता है।

हालांकि, HelpPageConfig की रजिस्टर विधि में, SetDocumentationProvider विधि XmlDocumentationProvider के उदाहरण को एक्सएमएल दस्तावेज़ फ़ाइल के भौतिक पथ के साथ निर्मित करने की अपेक्षा करता है।

क्या ऐसा करने का कोई और तरीका है? मुझे स्पष्ट नहीं है कि मुझे एक्सएमएल दस्तावेज फ़ाइल को इंगित करने की आवश्यकता क्यों है।

धन्यवाद

Answer 1

XmlDocumentationProvider xml फ़ाइल की तलाश में है (अपने xml कोड टिप्पणियों वाले) जो उत्पन्न हो जाता है जब आप अपने प्रोजेक्ट को संकलित। आप अपने प्रोजेक्ट प्रॉपर्टीज -> बिल्ड -> आउटपुट पर जाकर इसे उत्पन्न कर सकते हैं। एक्सएमएल दस्तावेज़ीकरण फ़ाइल के लिए चेकबॉक्स का चयन करें।

Answer 2

यदि आप अभी भी समस्या है तो नीचे दिए गए चरणों को देखें।

चरण 1 - संपत्ति प्रोजेक्ट गुण पृष्ठ बनाएँ और प्रलेखन

के लिए एक्सएमएल उत्पादन की स्थापना - नियंत्रक स्तर

// GET api/documentation 
/// <summary> 
/// This is how we create a documentation 
/// </summary> 
/// <returns></returns> 
public IEnumerable<string> Get() 

चरण 2 पर टिप्पणी जोड़ें चरण 3 - हेल्पपेज कॉन्फ़िगर

हमारे दस्तावेज़ XML फ़ाइल का उपयोग करने के लिए HelpPageConfig सेट अप करने के लिए, ~\Areas\HelpPage\HelpPageConfig.cs पर जाएं।

डिफ़ॉल्ट रूप से, config.SetDocumentationProvider कथन टिप्पणी की गई है। कि बयान का प्रयोग करें, और हमारे xml फ़ाइल को DocumentationProvider के स्थान इंगित:

public static void Register(HttpConfiguration config) 
{ 
    // Uncomment the following to use the documentation from XML documentation file. 
    config.SetDocumentationProvider(
      new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml"))); 
} 

संपादित करें: ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

VS2013 में बनाया एक नया वेब एपीआई 2.2 परियोजना में HelpPageConfig का स्थान है

Answer 3

मुझे पता है कि इस प्रश्न का उत्तर दिया गया है, लेकिन अगर यह में मदद करता है तो मुझे यह पृष्ठ मिला है क्योंकि IHttpActionResult

के लिए प्रलेखन के लिए समाधान की तलाश करने के कारण मुझे यह पृष्ठ मिला है

How to add IHttpActionResult into documentation