在Get/Post请求中向WebAPI方法传递序列化JSON对象的问题

我在Web服务中有如下方法：

[HttpGet] 
public HttpResponseMessage RegenerateReport(/*string reportObject*/) { 
    var result = new HttpResponseMessage(HttpStatusCode.OK); 
    result.Content = new StringContent("Operation completed."); 
    return result; 
}

该方法运行正常，但我希望能向此方法传递一个序列化后的JSON对象。

我尝试为该方法添加[HttpPost]标记，并通过以下代码调用：

var data = Encoding.ASCII.GetBytes(JsonConvert.SerializeObject(obj)); 
string _BaseUrl = ConfigurationManager.AppSettings["WebAPIBaseURL"]; 
HttpWebRequest request = WebRequest.Create(string.Format("{0}{1}", _BaseUrl, "test/RegenerateReport?FileName=" + RCFileName)) as HttpWebRequest; 
// Set type to POST 
request.Method = "Post"; 
request.ContentType = "application/xml"; 
request.ContentLength = data.Length; 
using (var stream = request.GetRequestStream()) { 
    stream.Write(data, 0, data.Length); 
} 
var response = (HttpWebResponse)request.GetResponse(); 
var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();

调用后返回错误：

The requested resource does not support http method 'GET'.

更新：我已为Web方法添加[HttpGet]和[HttpPost]双标记，该错误已消除。现咨询如何将序列化对象传递至该Web服务方法，感谢解答！

要实现传递序列化后的JSON对象到你的Web API方法，咱们可以分几步来调整：

1. 调整Web API方法的参数与特性 #

首先，你需要给方法添加一个能接收JSON对象的强类型参数，同时用[FromBody]特性明确告诉Web API从请求体中读取并自动反序列化这个对象。另外，既然主要用POST传递复杂对象，建议优先保留[HttpPost]（如果确实需要兼容GET也可以保留，但GET并不适合传递大体积的JSON内容）。

假设你的JSON对应的实体类是ReportRequest（你需要根据实际业务对象的结构来定义这个类），修改后的方法如下：

[HttpPost]
// 若需兼容GET可保留[HttpGet]，但不推荐用GET传复杂JSON
public HttpResponseMessage RegenerateReport([FromBody] ReportRequest reportObject) 
{ 
    // 这里可以直接使用已反序列化完成的reportObject
    var result = new HttpResponseMessage(HttpStatusCode.OK); 
    result.Content = new StringContent($"Operation completed. Received object: {JsonConvert.SerializeObject(reportObject)}"); 
    return result; 
}

// 示例实体类，根据你的obj实际结构调整属性
public class ReportRequest
{
    public string FileName { get; set; }
    // 其他需要传递的属性...
}

2. 修正客户端调用代码 #

你的客户端代码有两个关键问题需要调整：

• 你设置了ContentType = "application/xml"，但实际发送的是JSON，这会导致服务端无法正确解析请求体
• 你把FileName放在URL参数里，既然要传递整个对象，建议把它包含在JSON中一起发送

修改后的客户端代码：

// 构造包含所有需要传递属性的对象
var obj = new { FileName = RCFileName, /* 其他属性 */ };
var json = JsonConvert.SerializeObject(obj);
var data = Encoding.UTF8.GetBytes(json); // 推荐用UTF-8避免中文等特殊字符乱码
string _BaseUrl = ConfigurationManager.AppSettings["WebAPIBaseURL"]; 

// URL无需再拼接FileName参数，已包含在JSON中
HttpWebRequest request = WebRequest.Create($"{_BaseUrl}test/RegenerateReport") as HttpWebRequest; 
request.Method = "POST"; 
request.ContentType = "application/json"; // 必须改为application/json
request.ContentLength = data.Length; 

using (var stream = request.GetRequestStream()) { 
    stream.Write(data, 0, data.Length); 
} 

try
{
    var response = (HttpWebResponse)request.GetResponse(); 
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    // 处理响应内容
}
catch (WebException ex)
{
    // 捕获异常并查看详细错误信息，方便调试
    using (var errorStream = ex.Response.GetResponseStream())
    {
        var errorString = new StreamReader(errorStream).ReadToEnd();
        Console.WriteLine(errorString);
    }
}

3. 额外优化建议 #

• 确保你的Web API项目默认配置了JSON格式化支持（ASP.NET Web API默认已支持，若有特殊配置需确认）
• 如果对象结构复杂，可使用[JsonProperty]特性来映射JSON键名和实体类属性名
• 推荐使用更现代的HttpClient替代HttpWebRequest，代码更简洁易维护：

using (var client = new HttpClient())
{
    client.BaseAddress = new Uri(_BaseUrl);
    var json = JsonConvert.SerializeObject(obj);
    var content = new StringContent(json, Encoding.UTF8, "application/json");
    var response = await client.PostAsync("test/RegenerateReport", content);
    var responseString = await response.Content.ReadAsStringAsync();
}

这样调整后，你就能成功把序列化后的JSON对象传递到Web API方法中了！

内容的提问来源于stack exchange，提问作者Samra