Add extension methods for HTTP JSON requests/responses

src/Microsoft.AspNetCore.Blazor/Json/HttpClientJsonExtensions.cs

@@ -0,0 +1,117 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Net.Http;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.AspNetCore.Blazor
+{
+    /// <summary>
+    /// Extension methods for working with JSON APIs.
+    /// </summary>
+    public static class HttpClientJsonExtensions
+    {
+        /// <summary>
+        /// Sends a GET request to the specified URI, and parses the JSON response body
+        /// to create an object of the generic type.
+        /// </summary>
+        /// <typeparam name="T">A type into which the response body can be JSON-deserialized.</typeparam>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <returns>The response parsed as an object of the generic type.</returns>
+        public static async Task<T> GetJsonAsync<T>(this HttpClient httpClient, string requestUri)
+        {
+            var responseJson = await httpClient.GetStringAsync(requestUri);
+            return JsonUtil.Deserialize<T>(responseJson);
+        }
+
+        /// <summary>
+        /// Sends a POST request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format, and parses the JSON response body to create an object of the generic type.
+        /// </summary>
+        /// <typeparam name="T">A type into which the response body can be JSON-deserialized.</typeparam>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        /// <returns>The response parsed as an object of the generic type.</returns>
+        public static Task PostJsonAsync(this HttpClient httpClient, string requestUri, object content)
+            => httpClient.SendJsonAsync(HttpMethod.Post, requestUri, content);
+
+        /// <summary>
+        /// Sends a POST request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format, and parses the JSON response body to create an object of the generic type.
+        /// </summary>
+        /// <typeparam name="T">A type into which the response body can be JSON-deserialized.</typeparam>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        /// <returns>The response parsed as an object of the generic type.</returns>
+        public static Task<T> PostJsonAsync<T>(this HttpClient httpClient, string requestUri, object content)
+            => httpClient.SendJsonAsync<T>(HttpMethod.Post, requestUri, content);
+
+        /// <summary>
+        /// Sends a PUT request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format.
+        /// </summary>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        public static Task PutJsonAsync(this HttpClient httpClient, string requestUri, object content)
+            => httpClient.SendJsonAsync(HttpMethod.Put, requestUri, content);
+
+        /// <summary>
+        /// Sends a PUT request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format, and parses the JSON response body to create an object of the generic type.
+        /// </summary>
+        /// <typeparam name="T">A type into which the response body can be JSON-deserialized.</typeparam>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        /// <returns>The response parsed as an object of the generic type.</returns>
+        public static Task<T> PutJsonAsync<T>(this HttpClient httpClient, string requestUri, object content)
+            => httpClient.SendJsonAsync<T>(HttpMethod.Put, requestUri, content);
+
+        /// <summary>
+        /// Sends an HTTP request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format.
+        /// </summary>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="method">The HTTP method.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        public static Task SendJsonAsync(this HttpClient httpClient, HttpMethod method, string requestUri, object content)
+            => httpClient.SendJsonAsync<IgnoreResponse>(method, requestUri, content);
+
+        /// <summary>
+        /// Sends an HTTP request to the specified URI, including the specified <paramref name="content"/>
+        /// in JSON-encoded format, and parses the JSON response body to create an object of the generic type.
+        /// </summary>
+        /// <typeparam name="T">A type into which the response body can be JSON-deserialized.</typeparam>
+        /// <param name="httpClient">The <see cref="HttpClient"/>.</param>
+        /// <param name="method">The HTTP method.</param>
+        /// <param name="requestUri">The URI that the request will be sent to.</param>
+        /// <param name="content">Content for the request body. This will be JSON-encoded and sent as a string.</param>
+        /// <returns>The response parsed as an object of the generic type.</returns>
+        public static async Task<T> SendJsonAsync<T>(this HttpClient httpClient, HttpMethod method, string requestUri, object content)
+        {
+            var requestJson = JsonUtil.Serialize(content);
+            var response = await httpClient.SendAsync(new HttpRequestMessage(method, requestUri)
+            {
+                Content = new StringContent(requestJson, Encoding.UTF8, "application/json")
+            });
+
+            if (typeof(T) == typeof(IgnoreResponse))
+            {
+                return default;
+            }
+            else
+            {
+                var responseJson = await response.Content.ReadAsStringAsync();
+                return JsonUtil.Deserialize<T>(responseJson);
+            }
+        }
+
+        class IgnoreResponse { }
+    }
+}