使用 DELETE 要求與查詢字串 呼叫 Web API
由於，在這裡，我們使用的是查詢字串的方式來從用戶端傳遞資料到後端 Web API 伺服器上，所以，我們使用了
var fooFullUrl = $"{FooUrl}{apiData.Id}"; 這個敘述，來產生出最終的 URL；這裡會建立這樣格式的 URL，是因為後端的 Web API 之相對應的函式，有定義了相關路由屬性。
建立好要呼叫的 DELETE 要求的 URL 之後，我們使用
await client.DeleteAsync(fooFullUrl) 這個表示式，要求執行指定 URL的 DELETE 要求。
private static async Task<APIResult> JsonPutAsync(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}{apiData.Id}";
// Accept 用於宣告客戶端要求服務端回應的文件型態 (底下兩種方法皆可任選其一來使用)
//client.DefaultRequestHeaders.Accept.TryParseAdd("application/json");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
// Content-Type 用於宣告遞送給對方的文件型態
//client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json");
response = await client.DeleteAsync(fooFullUrl);
#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 Delete(int id) 動作(Action)，其該動作的原始碼如下所示。
這個 Web API 動作，將會回傳一個 APIData 的 JSON 資料。
[HttpDelete("{id}")]
public APIResult Delete(int id)
{
APIResult foo;
if (id == 777)
{
foo = new APIResult()
{
Success = true,
Message = "Id=777 資料 已經刪除了",
Payload = null
};
}
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 = JsonPutAsync(fooAPIData).Result;
Console.WriteLine($"使用 Delete 方法呼叫 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 = JsonPutAsync(fooAPIData).Result;
Console.WriteLine($"使用 Delete 方法呼叫 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();
}
執行結果
這個測試將會輸出底下內容
使用 Delete 方法呼叫 Web API 的結果
結果狀態 : True
結果訊息 : Id=777 資料 已經刪除了
Payload :
Press any key to Exist...
使用 Delete 方法呼叫 Web API 的結果
結果狀態 : False
結果訊息 : 無法發現到指定的 ID
Payload :
Press any key to Exist...
HTTP 傳送與接收原始封包
讓我們來看看，這個 Web API 的呼叫動作中，在請求 (Request) 與 反應 (Response) 這兩個階段，會在網路上傳送了那些 HTTP 資料
- 請求 (Request)在這裡的第一行中，您將會看到了完整有查詢字串 (Query String) 的 URL，在問號之後的內容，將會傳送到後端 Web API 動作函式的參數內，此時的 Id值為 777；不過，您也看到了，這裡是使用了 DELETE 要求來呼叫這次的 Web API。
DELETE http://vulcanwebapi.azurewebsites.net/api/values/777 HTTP/1.1
Accept: application/json
Host: vulcanwebapi.azurewebsites.net
Content-Length: 0
Connection: Keep-Alive
- 反應 (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 08:00:48 GMT
49
{"success":true,"message":"Id=777 資料 已經刪除了","payload":null}
0
- 請求 (Request)在這裡的第一行中，您將會看到了完整有查詢字串 (Query String) 的 URL，在問號之後的內容，將會傳送到後端 Web API 動作函式的參數內，此時的 Id值為 123；不過，您也看到了，這裡是使用了 DELETE 要求來呼叫這次的 Web API。
DELETE http://vulcanwebapi.azurewebsites.net/api/values/123 HTTP/1.1
Accept: application/json
Host: vulcanwebapi.azurewebsites.net
Content-Length: 0
- 反應 (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 08:00:49 GMT
48
{"success":false,"message":"無法發現到指定的 ID","payload":null}
0
相關文章索引
C# HttpClient WebAPI 系列文章索引
了解更多關於 [HttpClient Class] 的使用方式
了解更多關於 [使用 async 和 await 進行非同步程式設計] 的使用方式
關於 Xamarin 在台灣的學習技術資源
歡迎加入 Xamarin 實驗室 粉絲團，在這裡，將會經常性的貼出各種關於 Xamarin / Visual Studio / .NET 的相關消息、文章、技術開發等文件，讓您可以隨時掌握第一手的 Xamarin 方面消息。
歡迎加入 Xamarin.Forms @ Taiwan，這是台灣的 Xamarin User Group，若您有任何關於 Xamarin / Visual Studio / .NET 上的問題，都可以在這裡來與各方高手來進行討論、交流。
Xamarin 實驗室 部落格 是作者本身的部落格，這個部落格將會專注於 Xamarin 之跨平台 (Android / iOS / UWP) 方面的各類開技術探討、研究與分享的文章，最重要的是，它是全繁體中文。
Xamarin.Forms 系列課程 想要快速進入到 Xamarin.Forms 的開發領域，學會各種 Xamarin.Forms 跨平台開發技術，例如：MVVM、Prism、Data Binding、各種 頁面 Page / 版面配置 Layout / 控制項 Control 的用法等等，千萬不要錯過這些 Xamarin.Forms 課程
application/x-www-form-urlencoded/multipart/form-data/application/json編碼技巧之外，在這裡，我們使用了查詢字串的技巧，也就是說，我們透過了查詢字串 QueryString 將要刪除的欄位值，傳送到後端的 Web API。