Session 0205 (#68)

* Annotations demo

* Versioning samples

* WIP - trying to get OpenAPI + Versioning working

* Fixed versioning

* Completed demos

* Added gRPC client

* Updated docs and added streaming sample

* Started count demo

* Added reference for gRPC versioning

* Updated from stream

Author: csharpfritz

sessions/Season-02/0205-ApiPartTwo/README.md

@@ -0,0 +1,88 @@
+# Session 0205 - APIs Part 2: OpenAPI and gRPC
+
+## Agenda
+
+* Review API template
+* Discuss annotations to deliver more value using OpenAPI
+* API Clients
+* API versioning with OpenAPI
+* Introduce gRPC and gRPC template
+* gRPC client
+
+## OpenAPI
+
+The OpenAPI specification is a standard interface definition for RESTful services.According to [RapidAPI.com](https://rapidapi.com/blog/api-glossary/openapi/) the OpenAPI Specification is an open-source format and initiative for designing and creating machine-readable interface files that are utilized in producing, describing, consuming, and visualizing RESTful APIs and web services. The OpenAPI definition file defines an API with the following information
+
+* Present endpoints and each endpoint’s operations
+* The input and output operation parameters
+* Authentication techniques
+* Contact information, terms of use, license, and more
+
+OpenAPI and Swagger are sometimes used interchangeably.  Swagger was the name of the original specification and a company that implements tools for working with the public specification.  Swagger is now owned by SmartBear.
+
+For ASP.NET Core projects, the OpenAPI definition file is generated for you and made available at `/swagger/v1/swagger.json`
+
+### Customize OpenAPI
+
+Documentation is available with details to update [the Swagger UI provided with ASP.NET Core](https://docs.microsoft.com/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-5.0)
+
+### .NET OpenAPI tool for client
+
+There is an [OpenAPI command-line tool available](https://docs.microsoft.com/aspnet/core/web-api/Microsoft.dotnet-openapi?view=aspnetcore-5.0) to help you generate client-code that you can install with:
+
+```
+dotnet tool install --global Microsoft.dotnet-openapi --version 5.0.1
+```
+
+Add a service reference from the web to your client project with:
+
+```
+dotnet openapi add url https://localhost:5001/swagger/v1/swagger.json -p client.csproj
+```
+
+There are additional command-line options to add from local files, refresh your references, and remove the references.
+
+## HTTP-Repl
+
+You can use the [http-repl tool](https://docs.microsoft.com/aspnet/core/web-api/http-repl/?view=aspnetcore-5.0) to interact with your APIs on the command-line and using scripts.
+
+Install the http-repl using:
+
+```dotnetcli
+dotnet tool install -g Microsoft.dotnet-httprepl
+```
+
+You can then navigate around your API as though you were traversing folders and interacting with files on disk
+
+## gRPC Server
+
+- Add gRPC tools references
+
+`<PackageReference Include="Grpc.AspNetCore" Version="2.32.0" />`
+
+- Define a protobuf file and reference
+
+`<Protobuf Include="Protos\greet.proto" GrpcServices="Server" />`
+
+- ASP.NET Core generates services and message classes
+- Implement the service similar to a Controller
+
+## gRPC Client
+
+- Add gRPC package references: `Grpc.Net.ClientFactory`, `Grpc.Tools`
+- Import a protobuf file
+
+`<Protobuf Include="..\4_gRPC\Protos\greet.proto" GrpcServices="Client">`
+
+- Connect to the client
+
+```
+using var channel = GrpcChannel.ForAddress("https://localhost:5001");
+var client = new Greeter.GreeterClient(channel);
+```
+
+### Versioning gRPC
+
+tldr; Add a version number to the package definition `greeter.v1`
+
+Microsoft docs:  https://docs.microsoft.com/aspnet/core/grpc/versioning?view=aspnetcore-5.0

sessions/Season-02/0205-ApiPartTwo/nuget.config

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <!--To inherit the global NuGet package sources remove the <clear/> line below -->
+    <clear />
+    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

sessions/Season-02/0205-ApiPartTwo/src/1_Template/1_Template.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+    <RootNamespace>_1_Template</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="5.0.1" NoWarn="NU1605" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="5.0.1" NoWarn="NU1605" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
+  </ItemGroup>
+
+</Project>

sessions/Season-02/0205-ApiPartTwo/src/1_Template/Controllers/WeatherForecastController.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+
+namespace _1_Template.Controllers
+{
+    [ApiController]
+    [Route("[controller]")]
+    public class WeatherForecastController : ControllerBase
+    {
+        private static readonly string[] Summaries = new[]
+        {
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        };
+
+        private readonly ILogger<WeatherForecastController> _logger;
+
+        public WeatherForecastController(ILogger<WeatherForecastController> logger)
+        {
+            _logger = logger;
+        }
+
+        [HttpGet]
+        public IEnumerable<WeatherForecast> Get()
+        {
+            var rng = new Random();
+            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+            {
+                Date = DateTime.Now.AddDays(index),
+                TemperatureC = rng.Next(-20, 55),
+                Summary = Summaries[rng.Next(Summaries.Length)]
+            })
+            .ToArray();
+        }
+    }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/Program.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace _1_Template
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder =>
+                {
+                    webBuilder.UseStartup<Startup>();
+                });
+    }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/Properties/launchSettings.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:57845",
+      "sslPort": 44333
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "launchUrl": "swagger",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "_1_Template": {
+      "commandName": "Project",
+      "dotnetRunMessages": "true",
+      "launchBrowser": true,
+      "launchUrl": "swagger",
+      "applicationUrl": "https://localhost:5001;http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/Startup.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.HttpsPolicy;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using Microsoft.OpenApi.Models;
+
+namespace _1_Template
+{
+    public class Startup
+    {
+        public Startup(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public IConfiguration Configuration { get; }
+
+        // This method gets called by the runtime. Use this method to add services to the container.
+        public void ConfigureServices(IServiceCollection services)
+        {
+
+            services.AddControllers();
+            services.AddSwaggerGen(c =>
+            {
+                c.SwaggerDoc("v1", new OpenApiInfo { Title = "_1_Template", Version = "v1" });
+            });
+        }
+
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            if (env.IsDevelopment())
+            {
+                app.UseDeveloperExceptionPage();
+                app.UseSwagger();
+                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "_1_Template v1"));
+            }
+
+            app.UseHttpsRedirection();
+
+            app.UseRouting();
+
+            app.UseAuthorization();
+
+            app.UseEndpoints(endpoints =>
+            {
+                endpoints.MapControllers();
+            });
+        }
+    }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/WeatherForecast.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace _1_Template
+{
+    public class WeatherForecast
+    {
+        public DateTime Date { get; set; }
+
+        public int TemperatureC { get; set; }
+
+        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+
+        public string Summary { get; set; }
+    }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/appsettings.Development.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  }
+}

sessions/Season-02/0205-ApiPartTwo/src/1_Template/appsettings.json

@@ -0,0 +1,10 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "AllowedHosts": "*"
+}