使用 POST 要求與 JSON 編碼內容 呼叫 Web API
為了要能夠使用
application/json 編碼技術進行 POST 要求來呼較遠端的 Web API，我們需要藉由 JSON.NET 這個套件，幫助我們將要傳送過去的 .NET 物件，序列化成為 JSON 編碼格式的內容；var fooJSON = JsonConvert.SerializeObject(apiData); 這個敘述，就是做到這樣的目的。
我們使用
new StringContent(fooJSON, Encoding.UTF8, "application/json") 表示是，建立一個 fooContent 物件，從建立物件所使用的建構函式參數可以看出，我們要建立一個 application/json 編碼格式的 StringContent 物件
不過，因為
StringContent 類別以實作 IDisposable 介面，因此，我們使用 using 陳述式將其包起來，讓這個物件於使用完後，可以儘快的釋放掉非受管理的記憶體資源。
最後，我們就可以呼叫
await client.PostAsync(fooFullUrl, fooContent); 方法，將要傳送過去的資料，使用 application/json 編碼格式，送到 Web API 主機上對應的控制器與動作方法內。private static async Task<APIResult> JsonPostAsync(APIData apiData)
{
APIResult fooAPIResult;
using (HttpClientHandler handler = new HttpClientHandler())
{
using (HttpClient client = new HttpClient(handler))
{
try
{
#region 呼叫遠端 Web API
string FooUrl = $"http://vulcanwebapi.azurewebsites.net/api/Values";
HttpResponseMessage response = null;
#region 設定相關網址內容
var fooFullUrl = $"{FooUrl}";
// Accept 用於宣告客戶端要求服務端回應的文件型態 (底下兩種方法皆可任選其一來使用)
//client.DefaultRequestHeaders.Accept.TryParseAdd("application/json");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
// Content-Type 用於宣告遞送給對方的文件型態
//client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json");
var fooJSON = JsonConvert.SerializeObject(apiData);
// https://msdn.microsoft.com/zh-tw/library/system.net.http.stringcontent(v=vs.110).aspx
using (var fooContent = new StringContent(fooJSON, Encoding.UTF8, "application/json"))
{
response = await client.PostAsync(fooFullUrl, fooContent);
}
#endregion
#endregion
#region 處理呼叫完成 Web API 之後的回報結果
if (response != null)
{
if (response.IsSuccessStatusCode == true)
{
// 取得呼叫完成 API 後的回報內容
String strResult = await response.Content.ReadAsStringAsync();
fooAPIResult = JsonConvert.DeserializeObject<APIResult>(strResult, new JsonSerializerSettings { MetadataPropertyHandling = MetadataPropertyHandling.Ignore });
}
else
{
fooAPIResult = new APIResult
{
Success = false,
Message = string.Format("Error Code:{0}, Error Message:{1}", response.StatusCode, response.RequestMessage),
Payload = null,
};
}
}
else
{
fooAPIResult = new APIResult
{
Success = false,
Message = "應用程式呼叫 API 發生異常",
Payload = null,
};
}
#endregion
}
catch (Exception ex)
{
fooAPIResult = new APIResult
{
Success = false,
Message = ex.Message,
Payload = ex,
};
}
}
}
return fooAPIResult;
}
觸發的 Web API 動作
這個範例中，將會指向 URL
http://vulcanwebapi.azurewebsites.net/api/values ，此時，將會觸發 Web API 伺服器上的 Values 控制器(Controller)的 public APIResult Post([FromBody]APIData value) 動作(Action)，其該動作的原始碼如下所示。
這個 Web API 動作，將會回傳一個 APIData 的 JSON 資料。
[HttpPost]
public APIResult Post([FromBody]APIData value)
{
APIResult foo;
if (value.Id == 777)
{
foo = new APIResult()
{
Success = true,
Message = "透過 post 方法，接收到 Id=777 資料",
Payload = value
};
}
else
{
foo = new APIResult()
{
Success = false,
Message = "無法發現到指定的 ID",
Payload = null
};
}
return foo;
}
進行測試
在程式進入點函式，我們建立一個
APIData 型別的物件，接著，設定該物件的相關屬性，這些屬性值，是我們要傳送到遠端伺服器端的資料，由上面的程式碼中，我們可以知道，當 Id 這個屬性值為 777 的時候，該 Web API 動作將會回覆通知，這次的呼叫是成功的，否則，會回覆此次 Web API 呼叫失敗。static void Main(string[] args)
{
var fooAPIData = new APIData()
{
Id = 777,
Name = "VulcanSource",
};
var foo = JsonPostAsync(fooAPIData).Result;
Console.WriteLine($"使用 JSON 格式與使用 Post 方法呼叫 Web API 的結果");
Console.WriteLine($"結果狀態 : {foo.Success}");
Console.WriteLine($"結果訊息 : {foo.Message}");
Console.WriteLine($"Payload : {foo.Payload}");
Console.WriteLine($"");
Console.WriteLine($"Press any key to Exist...{Environment.NewLine}");
Console.ReadKey();
fooAPIData = new APIData()
{
Id = 123,
Name = "VulcanSource",
};
foo = JsonPostAsync(fooAPIData).Result;
Console.WriteLine($"使用 JSON 格式與使用 Post 方法呼叫 Web API 的結果");
Console.WriteLine($"結果狀態 : {foo.Success}");
Console.WriteLine($"結果訊息 : {foo.Message}");
Console.WriteLine($"Payload : {foo.Payload}");
Console.WriteLine($"");
Console.WriteLine($"Press any key to Exist...{Environment.NewLine}");
Console.ReadKey();
}
執行結果
這個測試將會輸出底下內容
使用 JSON 格式與使用 Post 方法呼叫 Web API 的結果
結果狀態 : True
結果訊息 : 透過 post 方法，接收到 Id=777 資料
Payload : {
"id": 777,
"name": "VulcanSource",
"filename": null
}
Press any key to Exist...
使用 JSON 格式與使用 Post 方法呼叫 Web API 的結果
結果狀態 : False
結果訊息 : 無法發現到指定的 ID
Payload :
Press any key to Exist...
HTTP 傳送與接收原始封包
讓我們來看看，這個 Web API 的呼叫動作中，在請求 (Request) 與 反應 (Response) 這兩個階段，會在網路上傳送了那些 HTTP 資料
- 請求 (Request)在這裡的第三行中，您將會看到有
Content-Type的 Http Header 欄位，他的值設定為application/json; charset=utf-8，這表示了這次的 POST 要求動作，將會使用 JSON 編碼的方式，將資料傳送到後端 Web API 伺服器上；會有這樣的結果產生，那是因為，我們有產生一個new StringContent(fooJSON, Encoding.UTF8, "application/json")這樣的物件，並且使用 PostAsync 方法，將這個物件傳送到這個非同步方法內。Content-Length這個 Http Header 欄位，C# 的 HttpClient 類別，會自動幫我們計算出，此次 Postmultipart/form-data編碼封包的總共大小。在最後一行，則是我們要傳送過去的物件之 JSON 編碼結果文字，在這裡，欄位 Id 的數值為 777。
POST http://vulcanwebapi.azurewebsites.net/api/Values HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: vulcanwebapi.azurewebsites.net
Content-Length: 48
Expect: 100-continue
Connection: Keep-Alive
{"Id":777,"Name":"VulcanSource","Filename":null}
- 反應 (Response)
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Kestrel
X-Powered-By: ASP.NET
Set-Cookie: ARRAffinity=9d3635139ab6649f453417d1e9047b7ed7a79b7bef031b04afeb6a2c58b33d4e;Path=/;HttpOnly;Domain=vulcanwebapi.azurewebsites.net
Date: Sun, 22 Oct 2017 04:48:42 GMT
84
{"success":true,"message":"透過 post 方法，接收到 Id=777 資料","payload":{"id":777,"name":"VulcanSource","filename":null}}
0
- 請求 (Request)在這裡的第三行中，您將會看到有
Content-Type的 Http Header 欄位，他的值設定為application/json; charset=utf-8，這表示了這次的 POST 要求動作，將會使用 JSON 編碼的方式，將資料傳送到後端 Web API 伺服器上；會有這樣的結果產生，那是因為，我們有產生一個new StringContent(fooJSON, Encoding.UTF8, "application/json")這樣的物件，並且使用 PostAsync 方法，將這個物件傳送到這個非同步方法內。Content-Length這個 Http Header 欄位，C# 的 HttpClient 類別，會自動幫我們計算出，此次 Postmultipart/form-data編碼封包的總共大小。在最後一行，則是我們要傳送過去的物件之 JSON 編碼結果文字，在這裡，欄位 Id 的數值為 123。
POST http://vulcanwebapi.azurewebsites.net/api/Values HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: vulcanwebapi.azurewebsites.net
Content-Length: 48
Expect: 100-continue
{"Id":123,"Name":"VulcanSource","Filename":null}
- 反應 (Response)
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Kestrel
X-Powered-By: ASP.NET
Set-Cookie: ARRAffinity=9d3635139ab6649f453417d1e9047b7ed7a79b7bef031b04afeb6a2c58b33d4e;Path=/;HttpOnly;Domain=vulcanwebapi.azurewebsites.net
Date: Sun, 22 Oct 2017 04:48:43 GMT
48
{"success":false,"message":"無法發現到指定的 ID","payload":null}
0
application/json編碼技術，從用戶端傳送到 Web API 伺服器端的方法