如何为具有Dictionary参数的GET请求创建正确的HELP页面?

时间:2019-02-06 14:44:31

标签: c# asp.net-mvc get asp.net-web-api2

我的API控制器中有一个Search方法。这是一个带有Dictionary keyValuePairs输入参数的GET请求。

代码就是这样。

[Route("Search")] 
[HttpGet]
public IHttpActionResult Search( Dictionary<string, string> keyValuePairs)
 {

  IDictionary<string, object> resultDict = new Dictionary<string, object>();  
  var keyValueParameters = this.Url.Request.GetQueryNameValuePairs();           

//Do bunch of things with keyValueParameters and fill up resultDict 

   return Ok(resultDict);

  }

帮助页面如下。 Request

Response  您可以在“请求信息”中看到“正文参数”,而在“响应信息”中看不到。 GET应该不是这样。 我肯定我需要处理涉及到的字典稍有不同,但是无法弄清楚。

1 个答案:

答案 0 :(得分:1)

似乎助手页面正在使用非常常见的ApiExplorer软件包。我自己没有尝试过,但是您可以在代码中添加类似的内容,以使其理解那里的正确响应是什么:

[ProducesResponseType(type: typeof(IDictionary<string, object>), statusCode: StatusCodes.Status200OK)]
public IHttpActionResult Search( Dictionary<string, string> keyValuePairs)