Added XML Document path for Swagger for summary and remark xml comments

Author: anomepani

WebGYM/WebGYM/Startup.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
+using System.Reflection;
 using System.Text;
 using System.Threading.Tasks;
 using AutoMapper;
@@ -16,6 +18,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.IdentityModel.Tokens;
 using Swashbuckle.AspNetCore.Swagger;
+using Swashbuckle.AspNetCore.SwaggerUI;
 using WebGYM.Common;
 using WebGYM.Concrete;
 using WebGYM.Interface;
@@ -43,7 +46,6 @@ public void ConfigureServices(IServiceCollection services)
                 options.MinimumSameSitePolicy = SameSiteMode.None;
             });
 
-
             #region MyRegion
             var connection = Configuration.GetConnectionString("DatabaseConnection");
             services.AddDbContext<DatabaseContext>(options => options.UseSqlServer(connection, b => b.UseRowNumberForPaging()));
@@ -183,6 +185,16 @@ public static IServiceCollection AddSwaggerDocumentation(this IServiceCollection
             {
                 c.SwaggerDoc("v1.0", new Info { Title = "Main API v1.0", Version = "v1.0" });
 
+                //Locate the XML file being generated by ASP.NET...
+                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.XML";
+                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+                if (File.Exists(xmlPath))
+                {
+                    //... and tell Swagger to use those XML comments.
+                    c.IncludeXmlComments(xmlPath);
+                }
+
+
                 // Swagger 2.+ support
                 var security = new Dictionary<string, IEnumerable<string>>
                 {
@@ -209,7 +221,10 @@ public static IApplicationBuilder UseSwaggerDocumentation(this IApplicationBuild
             {
                 c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "Gym Web API v1.0");
                 c.DocumentTitle = "Title Documentation";
-                c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None);
+                //Reference link : https://stackoverflow.com/questions/22008452/collapse-expand-swagger-response-model-class
+                //Reference link : https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking/
+                //  c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None);
+                // c.DocExpansion(DocExpansion.Full);
                 //    //Reference document: https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio
                 //    //To serve the Swagger UI at the app's root (http://localhost:<port>/), set the RoutePrefix property to an empty string:
                 c.RoutePrefix = string.Empty;

WebGYM/WebGYM/WebGYM.csproj

@@ -4,6 +4,12 @@
     <TargetFramework>netcoreapp2.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <NoWarn>1701;1702;1591</NoWarn>
+    <DocumentationFile>bin\Debug\netcoreapp2.1\WebGYM.xml</DocumentationFile>
+    <OutputPath>bin\Debug\netcoreapp2.1\</OutputPath>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="6.0.0" />
     <PackageReference Include="Microsoft.AspNetCore.App" />