Reply to thread

Message

<blockquote data-quote="MrTechno" data-source="post: 1160149" data-attributes="member: 111518">[USER=106003]@FreakyJ[/USER] my first thought would be to split the method in two:[CODE=C#]&nbsp; &nbsp; public dynamic Process(IHttpRequest request)&nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; // sort and filter&nbsp; &nbsp; &nbsp; HttpParam httpParam = request.Param;&nbsp; &nbsp; &nbsp; WebSortField? sort = GetHttpParam&lt;WebSortField&gt;(httpParam, &quot;sort&quot;);&nbsp; &nbsp; &nbsp; WebSortOrder? order = GetHttpParam&lt;WebSortOrder&gt;(httpParam, &quot;order&quot;);&nbsp; &nbsp; &nbsp; return Process(sort, order);&nbsp; &nbsp; }&nbsp; &nbsp; [ApiFunctionDescription(Type = ApiFunctionDescription.FunctionType.Json, Summary = &quot;&quot;)]&nbsp; &nbsp; [ApiFunctionParam(Name = &quot;sort&quot;, Type = typeof(WebSortField), Nullable = true)]&nbsp; &nbsp; [ApiFunctionParam(Name = &quot;order&quot;, Type = typeof(WebSortOrder), Nullable = true)]&nbsp; &nbsp; public List&lt;WebDriveBasic&gt; Process(WebSortField? sort, WebSortOrder? order)&nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; List&lt;WebDriveBasic&gt; output = DriveBasic();&nbsp; &nbsp; &nbsp; if (sort != null &amp;&amp; order != null)&nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; output = output.AsQueryable().SortMediaItemList(sort.Value, order.Value).ToList();&nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; return output;&nbsp; &nbsp; }[/CODE]Now it's a bit more obvious which ApiFunctionParam annotations belong to which parameter. Depending on the complexity of your documentation generator you might be able to get a lot of the information from the parameters themselves.My second thought which would require a lot more work up front but could be better in the long run would be to define the whole web API in RAML or Swagger and generate code stubs from the definition.</blockquote>

[QUOTE="MrTechno, post: 1160149, member: 111518"] [USER=106003]@FreakyJ[/USER] my first thought would be to split the method in two: [CODE=C#] public dynamic Process(IHttpRequest request) { // sort and filter HttpParam httpParam = request.Param; WebSortField? sort = GetHttpParam<WebSortField>(httpParam, "sort"); WebSortOrder? order = GetHttpParam<WebSortOrder>(httpParam, "order"); return Process(sort, order); } [ApiFunctionDescription(Type = ApiFunctionDescription.FunctionType.Json, Summary = "")] [ApiFunctionParam(Name = "sort", Type = typeof(WebSortField), Nullable = true)] [ApiFunctionParam(Name = "order", Type = typeof(WebSortOrder), Nullable = true)] public List<WebDriveBasic> Process(WebSortField? sort, WebSortOrder? order) { List<WebDriveBasic> output = DriveBasic(); if (sort != null && order != null) { output = output.AsQueryable().SortMediaItemList(sort.Value, order.Value).ToList(); } return output; }[/CODE] Now it's a bit more obvious which ApiFunctionParam annotations belong to which parameter. Depending on the complexity of your documentation generator you might be able to get a lot of the information from the parameters themselves. My second thought which would require a lot more work up front but could be better in the long run would be to define the whole web API in RAML or Swagger and generate code stubs from the definition. [/QUOTE]

Verification