在 Web API 控制器中接收 Json 字符串

Question

以下是我来自 WPF 应用程序的 Json 输入字符串，

{{
  "Country of Origin": "UNITED STATES",
  "Commodity": "APPLES",
  "Variety": "Green",
  "Upcs": [
    {
      "timestamp": "2017-09-19T21:05:12.8550708+05:30",
      "value": "038452735329R5"
    },
    {
      "timestamp": "2017-09-19T21:05:12.8550708+05:30",
      "value": "038452735330R5"
    }
  ],
  "ipAddress": "127.0.0.1",
  "lat": "155.00",
  "Lot": "101.14",
  "long": "-202.00",
  "onBehalfOf": "679",
  "ClientVersion": "10.0.7",
  "submittedBy": "679"
}}

我在 .net (VS2015) 中创建了一个 Rest Api2 应用程序，我想在我新创建的 API 中接收上述 JSON 字符串以进行进一步处理。

在 WPF 中，我使用 WebClient 发送 Json 字符串。

下面是我尝试接收Json字符串的API函数，

    [Route("api/events/getevents/{events}/{producerId}")]
    [HttpGet, HttpPost]
    public async Task<IHttpActionResult> GetEvents(string events, string producerId)
    {
        try
        {
            await _getEventsAction.GetEventJson(events, producerId).ConfigureAwait(false);
            return Ok("Success");
        }
        catch (AggregateException ex)
        {
            return Ok(new { ex.InnerException.Message, Success = false, ex.StackTrace, Exception = ex });
        }
        catch (Exception ex)
        {
            return Ok(new { ex.Message, Success = false, ex.StackTrace, Exception = ex });
        }
    }

在本地运行应用程序后，我通过证明以下值在 Web 浏览器中测试了 api，即对于 events="testing" 和 producerId="554"，最终端点如下所示，

http://localhost:18572/api/events/getevents/testing/554 -> 在这种情况下，端点在浏览器中工作正常。但是为了测试上面的 api，而不是 testing，当我在浏览器网址中输入整个 Json 字符串时，浏览器将错误显示为 "A potentially dangerous Request.Path value was detected from the client (:)." 。这是由于json字符串之间的双引号和冒号，浏览器显示错误页面。

下面的屏幕，

1. 我想知道，我开发的API函数接收Json字符串是正确的。如果有什么好的方法请指导我。

2. 请问有什么更好的方法可以通过输入 Json 字符串来测试此 API。

3. 是否可以在api中接收Json作为对象。

请帮助我编写此 API 以接收 Json 字符串或 Json 对象。

谢谢

Answer 1

通常情况下，当您需要发送 JSON 时，您应该发出 POST/PUT 请求并在请求正文中发送 JSON。

这样做：

1. 您需要创建与您的 JSON 匹配的模型：

   [DataContract]
   public class MyModel
   {
       [DataMember(Name = "Country of Origin")]
       public string CountryOfOrigin { get; set; }
   
       [DataMember(Name = "Commodity")]
       public string Commodity { get; set; }
   
       // other fields
   }
   

   另外，请注意我使用 DataContract 和 DataMember 属性作为传入 JSON 字段未规范化（字段有空格和不同的大小写 （camelCase 和 CamelCaps））。

   如果您要将 JSON 规范化为 camelCase，则可以删除 DataContract 和 DataMember 属性。

2. 将控制器中的操作更改为：

   [Route("api/events/getevents/{events}/{producerId}")]
   [HttpPost]
   public async Task<IHttpActionResult> GetEvents(string events, string producerId, [FromBody] MyModel model)
   {
       // your code
   }
   

   最后一个“模型”参数将填充您从客户端发送的值。

   [HttpPost] 属性表示此操作仅适用于 POST 请求。

   [FromBody] 属性表示 Web API 应该从请求的正文中获取模型。