add swagger to the identity / customer microservice

also: - add the hellang.middleware.problemdetails package - rewrite how serilog is configured
ShaylenReddy42 · Sep 24, 2022 · 0e6be05 · 0e6be05
1 parent 7741813
commit 0e6be05
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 19 deletions.
diff --git a/Services/SeelansTyres.Services.IdentityService/Program.cs b/Services/SeelansTyres.Services.IdentityService/Program.cs
@@ -1,43 +1,63 @@
+using Hellang.Middleware.ProblemDetails;
 using IdentityServer4.EntityFramework.DbContexts;
+using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Identity;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.OpenApi.Models;
 using SeelansTyres.Services.IdentityService.Authorization;
 using SeelansTyres.Services.IdentityService.Data;
 using SeelansTyres.Services.IdentityService.Data.Entities;
 using SeelansTyres.Services.IdentityService.Services;
 using Serilog;
 using Serilog.Events;
+using Serilog.Exceptions;
 using Serilog.Sinks.SystemConsole.Themes;
 using System.Reflection;
 
-Log.Logger = new LoggerConfiguration()
-    .MinimumLevel.Debug()
-    .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
-    .MinimumLevel.Override("Microsoft.Hosting.Lifetime", LogEventLevel.Information)
-    .MinimumLevel.Override("System", LogEventLevel.Warning)
-    .MinimumLevel.Override("Microsoft.AspNetCore.Authentication", LogEventLevel.Information)
-    .Enrich.FromLogContext()
-    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level}] {SourceContext}{NewLine}{Message:lj}{NewLine}{Exception}{NewLine}", theme: AnsiConsoleTheme.Code)
-    .CreateLogger();
-
 var builder = WebApplication.CreateBuilder(args);
 
-builder.Host.UseSerilog();
+builder.Host.UseSerilog((hostBuilderContext, loggerConfiguration) =>
+{
+    loggerConfiguration
+        .MinimumLevel.Debug()
+        .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
+        .MinimumLevel.Override("Microsoft.Hosting.Lifetime", LogEventLevel.Information)
+        .MinimumLevel.Override("System", LogEventLevel.Warning)
+        .MinimumLevel.Override("Microsoft.AspNetCore.Authentication", LogEventLevel.Information)
+        .Enrich.FromLogContext()
+        .Enrich.WithExceptionDetails()
+        .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level}] {SourceContext}{NewLine}{Message:lj}{NewLine}{Exception}{NewLine}", theme: AnsiConsoleTheme.Code);
+});
 
 var connectionString = builder.Configuration["SeelansTyresIdentityContext"];
 var assemblyName = typeof(Program).Assembly.GetName().Name;
 
-try
-{
-    Log.Information("Starting host...");
-}
-catch (Exception ex)
+builder.Services.AddControllersWithViews();
+
+builder.Services.AddEndpointsApiExplorer();
+builder.Services.AddSwaggerGen(setup =>
 {
-    Log.Fatal(ex, "Host terminated unexpectedly.");
-}
+    setup.AddSecurityDefinition("CustomerServiceAuth", new OpenApiSecurityScheme
+    {
+        Type = SecuritySchemeType.Http,
+        Scheme = JwtBearerDefaults.AuthenticationScheme,
+        Description = "Input a valid token to access this API"
+    });
 
-builder.Services.AddControllersWithViews();
+    setup.AddSecurityRequirement(new OpenApiSecurityRequirement
+    {{
+        new OpenApiSecurityScheme
+        {
+            Reference = new OpenApiReference
+            {
+                Type = ReferenceType.SecurityScheme,
+                Id = "CustomerServiceAuth"
+            }
+        },
+        new List<string>()
+    }});
+});
 
 builder.Services.AddDbContext<CustomerContext>(options =>
 {
@@ -131,8 +151,15 @@
 
 builder.Services.AddAutoMapper(Assembly.GetExecutingAssembly());
 
+builder.Services.AddProblemDetails(configure =>
+{
+    configure.IncludeExceptionDetails = (httpContext, exception) => false;
+});
+
 var app = builder.Build();
 
+app.UseProblemDetails();
+
 app.Urls.Clear();
 app.Urls.Add("https://localhost:5005");
 app.Urls.Add("http://localhost:4005");
@@ -144,6 +171,11 @@
     // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
     app.UseHsts();
 }
+else
+{
+    app.UseSwagger();
+    app.UseSwaggerUI();
+}
 
 app.UseHttpsRedirection();
 

diff --git a/Services/SeelansTyres.Services.IdentityService/SeelansTyres.Services.IdentityService.csproj b/Services/SeelansTyres.Services.IdentityService/SeelansTyres.Services.IdentityService.csproj
@@ -19,6 +19,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="8.1.1" />
+    <PackageReference Include="Hellang.Middleware.ProblemDetails" Version="6.5.1" />
     <PackageReference Include="IdentityServer4.AspNetIdentity" Version="4.1.2" />
     <PackageReference Include="IdentityServer4.EntityFramework" Version="4.1.2" />
     <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.8" />
@@ -29,6 +30,8 @@
     </PackageReference>
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.8" />
     <PackageReference Include="Serilog.AspNetCore" Version="6.0.1" />
+    <PackageReference Include="Serilog.Exceptions" Version="8.4.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0" />
   </ItemGroup>
 
 </Project>