मैं ASP.NET WebApi सहायता पृष्ठों में वैकल्पिक क्वेरीरीस्ट्रिंग पैरामीटर कैसे दस्तावेज़ करूं?

Question

एएसपी.Net वेब एपीआई सहायता पृष्ठ स्वचालित रूप से यह निर्धारित करने लगते हैं कि अनुरोध यूरी या बॉडी में पैरामीटर है या नहीं। मैं QueryString पैरामीटर वाले विकल्प पैरामीटर कैसे दस्तावेज़ित कर सकता हूं?

उदाहरण मैं इस तरह के रूप

[GET] api/Books?relatedToBookId=xx 

कहाँ "relatedToBookId" एक वैकल्पिक क्वेरी स्ट्रिंग पैरामीटर है एक RESTful यूआरएल हो सकता है है के लिए

।

आम तौर पर पैरामीटर FromUri या FromBody हैं

<param name="variableName">blah blah</param> 

Answer 1

के रूप में टिप्पणी में डाल रहे हैं निम्नलिखित और अपने वैकल्पिक क्वेरी स्ट्रिंग पैरामीटर जानकारी HelpPage में प्रकट होंगे आप कर सकता है।

नीचे दिए गए कोड में relatedToBookId क्वेरी स्ट्रिंग से आने वाला एक वैकल्पिक पैरामीटर है।

/// <summary> 
    /// Gets list of books 
    /// </summary> 
    /// <param name="relatedToBookId">Your description here</param> 
    /// <returns>returns list of books</returns> 
    public IEnumerable<Book> GetBooks(int? relatedToBookId = null) 

इसके अलावा, अगर आप इस पैरामीटर वैकल्पिक होने के बारे में उल्लेख करना चाहते हैं, तो आपको निम्न कर सकते हैं:

• स्थापित फाइल करने के लिए जाओ (क्षेत्रों/HelpPage/दृश्य/मदद/DisplayTemplates/Parameters.cshtml)

• अद्यतन निम्न के case ApiParameterSource.FromUri से संबंधित शर्त:

  case ApiParameterSource.FromUri: <p>Define this parameter in the request <b>URI</b>.</p> if(parameter.ParameterDescriptor.IsOptional) { <p>This parameter is <b>optional</b>.</p> } break;