如何将带有自定义标头的任意 JSON 数据发送到 REST 服务器?
-
22-12-2019 - |
题
TL;DR -- 如何将 JSON 字符串发送到带有 auth 标头的 REST 主机?我尝试了 3 种不同的方法,发现一种适用于匿名类型。为什么我不能使用匿名类型?我需要设置一个名为“Group-Name”的变量,并且连字符不是有效的 C# 标识符。
背景
我需要 POST JSON,但无法获取正确的正文和内容类型
函数 #1 - 使用匿名类型
内容类型和数据是正确的,但我不想使用匿名类型。我想用一个字符串
static void PostData(string restURLBase, string RESTUrl, string AuthToken, string postBody)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri(restURLBase);
client.DefaultRequestHeaders.Add("Auth-Token", AuthToken);
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
// StringContent content = new StringContent(postBody);
var test1 = "data1";
var test2 = "data2";
var test3 = "data3";
var response = client.PostAsJsonAsync(RESTUrl, new { test1, test2, test3}).Result; // Blocking call!
if (!response.IsSuccessStatusCode)
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
return;
}
}
输出#1
使用 AnonymousTypes + PostAsJsonAsync 时内容类型和数据是正确的,但我不想使用匿名类型。
POST https://api.dynect.net/REST/Zone/ABCqqqqqqqqqqqqYYYYYtes3ss.com HTTP/1.1
Auth-Token: --- REDACTED -----
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: api.dynect.net
Content-Length: 49
Expect: 100-continue
{"test1":"data1","test2":"data2","test3":"data3"}
功能 #2 - 未按预期工作
获取一个字符串并将其放入 StringContent 对象中。这会产生更改内容类型的副作用。
static void PostData(string restURLBase, string RESTUrl, string AuthToken, string postBody)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri(restURLBase);
client.DefaultRequestHeaders.Add("Auth-Token", AuthToken);
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
StringContent content = new StringContent(postBody);
var response = client.PostAsync(RESTUrl, content).Result; // Blocking call!
if (!response.IsSuccessStatusCode)
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
return;
}
}
输出#2
使用 StringContent + PostAsync 时内容类型错误
POST https://api.dynect.net/REST/Zone/ABCqqqqqqqqqqqqYYYYYtes3ss.com HTTP/1.1
Auth-Token: ---- REDACTED -------
Accept: application/json // CORRECT
Content-Type: text/plain; charset=utf-8 // WRONG!!!
Host: api.dynect.net
Content-Length: 100
Expect: 100-continue
{"rdata" : ["rname" : "dynect.nfp.com", "zone" : "ABCqqqqqqqqqqqqYYYYYtes3ss.com"], "ttl" : "43200"}
// ^^ THIS IS CORRECT
功能 #3 - 未按预期工作
自从我知道 PostAsJsonAsync
正确设置 contentType,让我们使用该方法。(不起作用)
static void PostData(string restURLBase, string RESTUrl, string AuthToken, string postBody)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri(restURLBase);
client.DefaultRequestHeaders.Add("Auth-Token", AuthToken);
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
StringContent content = new StringContent(postBody);
var response = client.PostAsJsonAsync(RESTUrl, content).Result; // Blocking call!
if (!response.IsSuccessStatusCode)
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
return;
}
}
输出#3
使用 StringContent + PostAsJsonAsync 时内容类型正确,POST 正文错误
POST https://api.dynect.net/REST/Zone/ABCqqqqqqqqqqqqYYYYYtes3ss.com HTTP/1.1
Auth-Token: -- REDACTED ---
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: api.dynect.net
Content-Length: 74
Expect: 100-continue
{"Headers":[{"Key":"Content-Type","Value":["text/plain; charset=utf-8"]}]}
问题
我想要做的就是将 JSON 作为字符串或在运行时定义的动态对象发送到服务器,并使用正确的 HTTP 内容类型和特殊的“Auth-Token”标头。
任何示例,如果不使用 WebAPI,例如 servicestack,或其他任何东西都很酷。
解决方案
/// <summary>
/// Creates a new instance of the <see cref="T:System.Net.Http.StringContent"/> class.
/// </summary>
/// <param name="content">The content used to initialize the <see cref="T:System.Net.Http.StringContent"/>.</param><param name="encoding">The encoding to use for the content.</param><param name="mediaType">The media type to use for the content.</param>
[__DynamicallyInvokable]
public StringContent(string content, Encoding encoding, string mediaType)
: base(StringContent.GetContentByteArray(content, encoding))
{
this.Headers.ContentType = new MediaTypeHeaderValue(mediaType == null ? "text/plain" : mediaType)
{
CharSet = encoding == null ? HttpContent.DefaultStringEncoding.WebName : encoding.WebName
};
}
它是 StringContent 的构造函数。看起来您应该指定适当的 Encoding 和 mediaType
其他提示
您不能直接设置 HttpContent 的实例,因为它是一个抽象类。您需要根据需要使用子类之一。最有可能的是 StringContent,它允许您在构造函数中设置响应的字符串值、编码和媒体类型: http://msdn.microsoft.com/en-us/library/system.net.http.stringcontent.aspx