Added Swashbuckle.AspNetCore Package, Startup Setup and added XML documentation to TestRegistersController

Author: DavidSuescunPelegay

src/jQueryDatatableServerSideNetCore/Controllers/TestRegistersController.cs

@@ -13,26 +13,44 @@
 
 namespace jQueryDatatableServerSideNetCore.Controllers
 {
+    /// <summary>
+    ///   <br />
+    /// </summary>
+    [ApiController]
+    [Route("[controller]")]
     public class TestRegistersController : Controller
     {
         private readonly ApplicationDbContext _context;
         private readonly IExportService _exportService;
 
+        /// <summary>Initializes a new instance of the <see cref="TestRegistersController" /> class.</summary>
+        /// <param name="context">The context.</param>
+        /// <param name="exportService">The export service.</param>
         public TestRegistersController(ApplicationDbContext context, IExportService exportService)
         {
             _context = context;
             _exportService = exportService;
         }
 
         // GET: TestRegisters
+        /// <summary>Indexes this instance.</summary>
+        /// <returns>
+        ///   <br />
+        /// </returns>
+        [HttpGet]
         public async Task<IActionResult> Index()
         {
             await SeedData();
 
             return View();
         }
 
-        [HttpPost]
+        /// <summary>Loads the table.</summary>
+        /// <param name="dtParameters">The dt parameters.</param>
+        /// <returns>
+        ///   <br />
+        /// </returns>
+        [HttpPost("LoadTable")]
         public async Task<IActionResult> LoadTable([FromBody] DtParameters dtParameters)
         {
             var searchBy = dtParameters.Search?.Value;
@@ -80,7 +98,13 @@ public async Task<IActionResult> LoadTable([FromBody] DtParameters dtParameters)
             });
         }
 
-        [HttpPost]
+        /// <summary>Exports the table.</summary>
+        /// <param name="format">The format.</param>
+        /// <param name="dtParametersJson">The dt parameters json.</param>
+        /// <returns>
+        ///   <br />
+        /// </returns>
+        [HttpPost("ExportTable")]
         public async Task<IActionResult> ExportTable([FromQuery] string format, [FromForm] string dtParametersJson)
         {
             var dtParameters = new DtParameters();
@@ -136,6 +160,8 @@ public async Task<IActionResult> ExportTable([FromQuery] string format, [FromFor
             return null;
         }
 
+        /// <summary>Seeds the data.</summary>
+        [NonAction]
         public async Task SeedData()
         {
             if (!_context.TestRegisters.Any())

src/jQueryDatatableServerSideNetCore/Properties/launchSettings.json

@@ -11,13 +11,15 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
+      "launchUrl": "TestRegisters",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
     "jQueryDatatableServerSideNetCore": {
       "commandName": "Project",
       "launchBrowser": true,
+      "launchUrl": "TestRegisters",
       "applicationUrl": "https://localhost:5001;http://localhost:5000",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

src/jQueryDatatableServerSideNetCore/Startup.cs

@@ -7,7 +7,12 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.OpenApi.Models;
 using Newtonsoft.Json.Converters;
+using System;
+using System.IO;
+using System.Linq;
+using System.Reflection;
 
 namespace jQueryDatatableServerSideNetCore
 {
@@ -38,6 +43,17 @@ public void ConfigureServices(IServiceCollection services)
             services.AddRazorPages();
 
             services.AddScoped<IExportService, ExportService>();
+
+            // Register the Swagger generator, defining 1 or more Swagger documents
+            services.AddSwaggerGen(c =>
+            {
+                c.SwaggerDoc("v1", new OpenApiInfo { Title = "jQueryDatatableServerSideNetCore", Version = "v1" });
+                c.ResolveConflictingActions(apiDescriptions => apiDescriptions.FirstOrDefault());
+
+                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+                c.IncludeXmlComments(xmlPath);
+            });
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
@@ -57,6 +73,14 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseHttpsRedirection();
             app.UseStaticFiles();
 
+            // Enable middleware to serve generated Swagger as a JSON endpoint.
+            app.UseSwagger();
+            app.UseSwaggerUI(c =>
+            {
+                c.RoutePrefix = "docs";
+                c.SwaggerEndpoint("/swagger/v1/swagger.json", "jQueryDatatableServerSideNetCore Docs v1");
+            });
+
             app.UseRouting();
 
             app.UseAuthentication();
@@ -66,7 +90,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             {
                 endpoints.MapControllerRoute(
                     name: "default",
-                    pattern: "{controller=Home}/{action=Index}/{id?}");
+                    pattern: "{controller=TestRegisters}/{action=Index}/{id?}");
                 endpoints.MapRazorPages();
             });
         }

src/jQueryDatatableServerSideNetCore/Views/Shared/_Layout.cshtml

@@ -32,6 +32,9 @@
                         <li class="nav-item">
                             <a class="nav-link text-dark" asp-area="" asp-controller="TestRegisters" asp-action="Index">Test DataTable</a>
                         </li>
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" href="docs" target="_blank">Swagger DOCS <span class="badge rounded-pill bg-info text-dark">New</span></a>
+                        </li>
                     </ul>
                 </div>
             </div>

src/jQueryDatatableServerSideNetCore/jQueryDatatableServerSideNetCore.csproj

@@ -5,6 +5,13 @@
     <UserSecretsId>aspnet-jQueryDatatableServerSideNetCore-F30D421D-7C39-47E7-8247-3E3BE3C0B128</UserSecretsId>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>obj\Debug\net5.0\jQueryDatatableServerSideNetCore.xml</DocumentationFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <DocumentationFile>obj\Release\net5.0\jQueryDatatableServerSideNetCore.xml</DocumentationFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="EPPlus" Version="5.8.0" />
@@ -18,6 +25,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="RandomGen" Version="1.1.5" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="6.2.3" />
   </ItemGroup>
-
 </Project>