Starting work on HttpClientFactory documentation

aspnetcore/fundamentals/http-requests.md

@@ -48,7 +48,7 @@ Using `IHttpClientFactory` in this fashion is a great way to refactor an existin
 
 ### Named clients
 
-If an app requires multiple distinct uses of `HttpClient`, each with different configurations, an option is to use **named clients**. Configuration for a named `HttpClient` can be specified during registration in `ConfigureServices`.
+If an app requires multiple distinct uses of `HttpClient`, each with a different configuration, an option is to use **named clients**. Configuration for a named `HttpClient` can be specified during registration in `ConfigureServices`.
 
 [!code-csharp[](http-requests/samples/Startup.cs?name=snippet2)]
 
@@ -60,7 +60,7 @@ To consume a named client, a string parameter can be passed to `CreateClient`. S
 
 [!code-csharp[](http-requests/samples/Pages/NamedClient.cshtml.cs?name=snippet1&highlight=14-18)]
 
-In the preceding code, the request doesn't need to specify a hostname. I can provide just the path, since the base address configured for the client is used.
+In the preceding code, the request doesn't need to specify a hostname. It can pass just the path, since the base address configured for the client is used.
 
 ### Typed clients
 

aspnetcore/fundamentals/http-requests/samples/GitHub/GitHubService.cs

@@ -1,8 +1,7 @@
 using System;
-using System.IO;
+using System.Collections.Generic;
 using System.Net.Http;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 
 namespace HttpClientFactorySample.GitHub
 {
@@ -23,33 +22,15 @@ public GitHubService(HttpClient client)
             Client = client;
         }
 
-        public async Task<GitHubIssue> GetLatestDocsIssue()
+        public async Task<IEnumerable<GitHubIssue>> GetAspNetDocsIssues()
         {
-            var response = await Client.GetAsync("/repos/aspnet/docs/issues?state=open&sort=created&direction=desc", HttpCompletionOption.ResponseHeadersRead);
+            var response = await Client.GetAsync("/repos/aspnet/docs/issues?state=open&sort=created&direction=desc");
 
             response.EnsureSuccessStatusCode();
 
-            using (var stream = await response.Content.ReadAsStreamAsync())
-            using (var streamReader = new StreamReader(stream))
-            using (var jsonReader = new JsonTextReader(streamReader))
-            {
-                var serializer = new JsonSerializer();
+            var result = await response.Content.ReadAsAsync<IEnumerable<GitHubIssue>>();
 
-                while (await jsonReader.ReadAsync())
-                {
-                    if (jsonReader.TokenType == JsonToken.StartObject)
-                    {
-                        var issue = serializer.Deserialize<GitHubIssue>(jsonReader);
-
-                        if (issue != null)
-                        {
-                            return issue; // we only want the first object
-                        }
-                    }
-                }
-            }
-
-            return null;
+            return result;
         }
     }
     #endregion

aspnetcore/fundamentals/http-requests/samples/GitHub/RepoService.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using System.Net.Http;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 
 namespace HttpClientFactorySample.GitHub
 {
@@ -21,9 +20,9 @@ public async Task<IEnumerable<string>> GetRepos()
 
             response.EnsureSuccessStatusCode();
 
-            var responseContent = await response.Content.ReadAsStringAsync();
+            var result = await response.Content.ReadAsAsync<IEnumerable<string>>();
 
-            return JsonConvert.DeserializeObject<IEnumerable<string>>(responseContent);
+            return result;
         }
     }
     #endregion

aspnetcore/fundamentals/http-requests/samples/Pages/BasicUsage.cshtml

@@ -1,13 +1,21 @@
 @page
 @model BasicUsageModel
 @{
+    ViewData["Title"] = "Branches for Docs Repo";
 }
 
-<h1>Branches for Docs Repo</h1>
+<h1>@ViewData["Title"]</h1>
 
-<ul>
-    @foreach (var branch in Model.Branches)
-    {
-        <li>@branch.Name</li>
-    }
-</ul>
+@if (Model.GetBranchesError)
+{
+    <p>Unable to get branches from GitHub. Please try again later.</p>
+}
+else
+{
+    <ul>
+        @foreach (var branch in Model.Branches)
+        {
+            <li>@branch.Name</li>
+        }
+    </ul>
+}

aspnetcore/fundamentals/http-requests/samples/Pages/BasicUsage.cshtml.cs

@@ -4,7 +4,6 @@
 using System.Threading.Tasks;
 using HttpClientFactorySample.GitHub;
 using Microsoft.AspNetCore.Mvc.RazorPages;
-using Newtonsoft.Json;
 
 namespace HttpClientFactorySample.Pages
 {
@@ -15,14 +14,16 @@ public class BasicUsageModel : PageModel
 
         public IEnumerable<GitHubBranch> Branches { get; private set; }
 
+        public bool GetBranchesError { get; private set; }
+
         public BasicUsageModel(IHttpClientFactory clientFactory)
         {
             _clientFactory = clientFactory;
         }
 
         public async Task OnGet()
         {
-            var request = new HttpRequestMessage(HttpMethod.Get, "https://api.github.com/repos/aspnet/docs/branches" );
+            var request = new HttpRequestMessage(HttpMethod.Get, "https://api.github.com/repos/aspnet/docs/branches");
             request.Headers.Add("Accept", "application/vnd.github.v3+json");
             request.Headers.Add("User-Agent", "HttpClientFactory-Sample");
 
@@ -32,13 +33,13 @@ public async Task OnGet()
 
             if (response.IsSuccessStatusCode)
             {
-                var data = await response.Content.ReadAsStringAsync();
-                Branches = JsonConvert.DeserializeObject<IEnumerable<GitHubBranch>>(data);
+                Branches = await response.Content.ReadAsAsync<IEnumerable<GitHubBranch>>();
             }
             else
             {
+                GetBranchesError = true;
                 Branches = Array.Empty<GitHubBranch>();
-            }
+            }                               
         }
     }
     #endregion

aspnetcore/fundamentals/http-requests/samples/Pages/NamedClient.cshtml

@@ -6,9 +6,18 @@
 
 <h1>@ViewData["Title"]</h1>
 
-<ul>
+@if (Model.GetPullRequestsError)
+{
+    <p>Unable to get issues from GitHub. Please try again later.</p>
+}
+else if (Model.HasPullRequests)
+{
     @foreach (var pr in Model.PullRequests)
     {
         <li>@pr.Title</li>
     }
-</ul>
+}
+else
+{
+    <p>No pull requests found.</p>
+}

aspnetcore/fundamentals/http-requests/samples/Pages/NamedClient.cshtml.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 using HttpClientFactorySample.GitHub;
@@ -15,6 +16,10 @@ public class NamedClientModel : PageModel
 
         public IEnumerable<GitHubPullRequest> PullRequests { get; private set; }
 
+        public bool GetPullRequestsError { get; private set; }
+
+        public bool HasPullRequests => PullRequests.Any();
+
         public NamedClientModel(IHttpClientFactory clientFactory)
         {
             _clientFactory = clientFactory;
@@ -30,11 +35,11 @@ public async Task OnGet()
 
             if (response.IsSuccessStatusCode)
             {
-                var data = await response.Content.ReadAsStringAsync();
-                PullRequests = JsonConvert.DeserializeObject<IEnumerable<GitHubPullRequest>>(data);
+                PullRequests = await response.Content.ReadAsAsync<IEnumerable<GitHubPullRequest>>();
             }
             else
             {
+                GetPullRequestsError = true;
                 PullRequests = Array.Empty<GitHubPullRequest>();
             }
         }

aspnetcore/fundamentals/http-requests/samples/Pages/TypedClient.cshtml

@@ -1,16 +1,24 @@
 @page
 @model TypedClientModel
 @{
+    ViewData["Title"] = "Latest GitHub Issues for ASP.NET Docs";
 }
 
-<h1>Latest GitHub Issue for ASP.NET Docs</h1>
+<h1>@ViewData["Title"]</h1>
 
-@if (Model.HasIssue)
+@if (Model.GetIssuesError)
 {
-    <h2>Title: @Model.LastestIssue.Title</h2>
-    <p><a href="@Model.LastestIssue.Url">View Issue</a></p>
+    <p>Unable to get issues from GitHub. Please try again later.</p>
+}
+else if (Model.HasIssue)
+{
+    @foreach (var issue in Model.LastestIssues)
+    {
+        <h2>Title: @issue.Title</h2>
+        <p><a href="@issue.Url">View Issue</a></p>
+    }
 }
 else
 {
     <p>No issues found.</p>
-}
+}

aspnetcore/fundamentals/http-requests/samples/Pages/TypedClient.cshtml.cs

@@ -1,3 +1,7 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net.Http;
 using System.Threading.Tasks;
 using HttpClientFactorySample.GitHub;
 using Microsoft.AspNetCore.Mvc.RazorPages;
@@ -9,9 +13,11 @@ public class TypedClientModel : PageModel
     {
         private readonly GitHubService _gitHubService;
 
-        public GitHubIssue LastestIssue { get; private set; }
+        public IEnumerable<GitHubIssue> LastestIssues { get; private set; }
 
-        public bool HasIssue => LastestIssue != null;
+        public bool HasIssue => LastestIssues.Any();
+
+        public bool GetIssuesError { get; private set; }
 
         public TypedClientModel(GitHubService gitHubService)
         {
@@ -20,7 +26,15 @@ public TypedClientModel(GitHubService gitHubService)
 
         public async Task OnGet()
         {
-            LastestIssue = await _gitHubService.GetLatestDocsIssue();
+            try
+            {
+                LastestIssues = await _gitHubService.GetAspNetDocsIssues();
+            }
+            catch(HttpRequestException)
+            {
+                GetIssuesError = true;
+                LastestIssues = Array.Empty<GitHubIssue>();
+            }            
         }
     }
     #endregion