Add API versioning and apply ApiGroup attribute

Author: KrzysztofPajak

src/Core/Grand.SharedKernel/Extensions/ApiConstants.cs

@@ -0,0 +1,7 @@
+namespace Grand.SharedKernel.Extensions;
+
+public static class ApiConstants
+{
+    public const string ApiGroupNameV1 = "v1";
+    public const string ApiGroupNameV2 = "v2";
+}

src/Web/Grand.Web/Controllers/BlogController.cs

@@ -16,9 +16,11 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.DependencyInjection;
+using Grand.SharedKernel.Attributes;
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class BlogController : BasePublicController
 {
     #region Constructors

src/Web/Grand.Web/Controllers/CatalogController.cs

@@ -9,7 +9,6 @@
 using Grand.Business.Core.Interfaces.Customers;
 using Grand.Domain.Permissions;
 using Grand.Domain.Catalog;
-using Grand.Domain.Customers;
 using Grand.Domain.Vendors;
 using Grand.Infrastructure;
 using Grand.Web.Commands.Models.Vendors;
@@ -21,9 +20,12 @@
 using Grand.Web.Models.Vendors;
 using MediatR;
 using Microsoft.AspNetCore.Mvc;
+using Grand.SharedKernel.Attributes;
+using Microsoft.AspNetCore.Http;
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class CatalogController : BasePublicController
 {
     #region Constructors
@@ -89,6 +91,7 @@ private VendorReviewOverviewModel PrepareVendorReviewOverviewModel(Domain.Vendor
 
     #region Categories
 
+    [ProducesResponseType(typeof(CategoryModel), StatusCodes.Status200OK)]
     [HttpGet]
     public virtual async Task<IActionResult> Category(string categoryId, CatalogPagingFilteringModel command)
     {
@@ -319,8 +322,7 @@ public virtual async Task<IActionResult> VendorAll(VendorPagingModel command)
     [HttpPost]
     [AutoValidateAntiforgeryToken]
     [DenySystemAccount]
-    public virtual async Task<IActionResult> VendorReviews(
-        VendorReviewsModel model)
+    public virtual async Task<IActionResult> VendorReviews(VendorReviewsModel model)
     {
         var vendor = await _vendorService.GetVendorById(model.VendorId);
         if (vendor is not { Active: true } || !vendor.AllowCustomerReviews)

src/Web/Grand.Web/Controllers/CheckoutController.cs

@@ -16,6 +16,7 @@
 using Grand.Domain.Shipping;
 using Grand.Infrastructure;
 using Grand.Infrastructure.Extensions;
+using Grand.SharedKernel.Attributes;
 using Grand.Web.Common.Controllers;
 using Grand.Web.Common.Filters;
 using Grand.Web.Extensions;
@@ -30,6 +31,7 @@
 namespace Grand.Web.Controllers;
 
 [DenySystemAccount]
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class CheckoutController : BasePublicController
 {
     #region Constructors

src/Web/Grand.Web/Controllers/CommonController.cs

@@ -29,6 +29,7 @@
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class CommonController : BasePublicController
 {
     #region Constructors

src/Web/Grand.Web/Controllers/ContactController.cs

@@ -6,6 +6,7 @@
 using Grand.Domain.Media;
 using Grand.Domain.Stores;
 using Grand.Infrastructure;
+using Grand.SharedKernel.Attributes;
 using Grand.Web.Commands.Models.Contact;
 using Grand.Web.Common.Controllers;
 using Grand.Web.Common.Extensions;
@@ -18,6 +19,7 @@
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class ContactController : BasePublicController
 {
     #region Constructors

src/Web/Grand.Web/Controllers/CountryController.cs

@@ -1,4 +1,5 @@
 using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.SharedKernel.Attributes;
 using Grand.Web.Common.Controllers;
 using Grand.Web.Common.Filters;
 using Grand.Web.Features.Models.Common;
@@ -8,6 +9,7 @@
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class CountryController : BasePublicController
 {
     #region Constructors

src/Web/Grand.Web/Controllers/CourseController.cs

@@ -12,9 +12,11 @@
 using Grand.Web.Features.Models.Courses;
 using MediatR;
 using Microsoft.AspNetCore.Mvc;
+using Grand.SharedKernel.Attributes;
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class CourseController : BasePublicController
 {
     private readonly IAclService _aclService;

src/Web/Grand.Web/Controllers/DownloadController.cs

@@ -9,6 +9,7 @@
 using Grand.Domain.Customers;
 using Grand.Domain.Orders;
 using Grand.Infrastructure;
+using Grand.SharedKernel.Attributes;
 using Grand.Web.Common.Controllers;
 using Grand.Web.Common.Filters;
 using Microsoft.AspNetCore.Mvc;
@@ -19,6 +20,7 @@
 namespace Grand.Web.Controllers;
 
 [DenySystemAccount]
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class DownloadController : BasePublicController
 {
     private readonly CustomerSettings _customerSettings;

src/Web/Grand.Web/Controllers/KnowledgebaseController.cs

@@ -18,9 +18,11 @@
 using Grand.Web.Extensions;
 using Grand.Web.Models.Knowledgebase;
 using Microsoft.AspNetCore.Mvc;
+using Grand.SharedKernel.Attributes;
 
 namespace Grand.Web.Controllers;
 
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
 public class KnowledgebaseController : BasePublicController
 {
     private readonly IAclService _aclService;