Merge pull request #9 from Amitpnk/develop

Develop

Author: Amitpnk

Assert/OnionArchitecture_icon.png

@@ -9,5 +9,17 @@ public static void ConfigureCustomExceptionMiddleware(this IApplicationBuilder a
         {
             app.UseMiddleware<CustomExceptionMiddleware>();
         }
+
+        public static void ConfigureSwagger(this IApplicationBuilder app)
+        {
+            app.UseSwagger();
+
+            app.UseSwaggerUI(setupAction =>
+            {
+                setupAction.SwaggerEndpoint("/swagger/OpenAPISpecification/swagger.json", "Onion Architecture API");
+                setupAction.RoutePrefix = string.Empty;
+            });
+        }
+
     }
 }

Assert/Step1.png

@@ -8,6 +8,9 @@
 using OnionArchitecture.Persistence.Repository;
 using OnionArchitecture.Service.Contract;
 using OnionArchitecture.Service.ImplementationBL;
+using System;
+using System.IO;
+using System.Reflection;
 
 namespace OnionArchitecture.Infrastructure.Extension
 {
@@ -42,5 +45,36 @@ public static void AddTransientServices(this IServiceCollection serviceCollectio
             serviceCollection.AddTransient<ICustomerService, CustomerService>();
         }
 
+        public static void AddSwaggerOpenAPI(this IServiceCollection serviceCollection)
+        {
+            serviceCollection.AddSwaggerGen(setupAction =>
+            {
+                setupAction.SwaggerDoc(
+                    "OpenAPISpecification",
+                    new Microsoft.OpenApi.Models.OpenApiInfo()
+                    {
+                        Title = "Customer API",
+                        Version = "1",
+                        Description = "Through this API you can access customer details",
+                        Contact = new Microsoft.OpenApi.Models.OpenApiContact()
+                        {
+                            Email = "amit.naik8103@gmail.com",
+                            Name = "Amit Naik",
+                            Url = new Uri("https://amitpnk.github.io/")
+                        },
+                        License = new Microsoft.OpenApi.Models.OpenApiLicense()
+                        {
+                            Name = "MIT License",
+                            Url = new Uri("https://opensource.org/licenses/MIT")
+                        }
+                    });
+
+                var xmlCommentsFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+                var xmlCommentsFullPath = Path.Combine(AppContext.BaseDirectory, xmlCommentsFile);
+                setupAction.IncludeXmlComments(xmlCommentsFullPath);
+            });
+
+        }
+
     }
 }

Assert/Step2.PNG

@@ -4,12 +4,18 @@
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>OnionArchitecture.Infrastructure.xml</DocumentationFile>
+    <NoWarn>1701;1702;1591</NoWarn>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="7.0.0" />
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.1.5" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.1.5" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.5.0" />
   </ItemGroup>
 
   <ItemGroup>

Assert/Step3.PNG

@@ -4,6 +4,11 @@
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>OnionArchitectureSwagger.xml</DocumentationFile>
+    <NoWarn>1701;1702;1591</NoWarn>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="7.0.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.5">