Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

Add ProducesResponseType and ApiGroup attributes (#568)

Krzysztof Pajak649295a8f1b4
diff --git a/src/Web/Grand.Web/Controllers/AccountController.cs b/src/Web/Grand.Web/Controllers/AccountController.cs
index 506ff202a..082c1d737 100644
--- a/src/Web/Grand.Web/Controllers/AccountController.cs
+++ b/src/Web/Grand.Web/Controllers/AccountController.cs
@@ -20,6 +20,7 @@ using Grand.Web.Common.Security.Captcha;
using Grand.Web.Extensions;
using Grand.Web.Features.Models.Common;
using Grand.Web.Features.Models.Customers;
+using Grand.Web.Models.Common;
using Grand.Web.Models.Customer;
using MediatR;
using Microsoft.AspNetCore.Http;
@@ -28,6 +29,7 @@ using Microsoft.AspNetCore.Mvc;
namespace Grand.Web.Controllers;
[DenySystemAccount]
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
public class AccountController : BasePublicController
{
#region Ctor
@@ -357,6 +359,7 @@ public class AccountController : BasePublicController
[HttpPost]
[AutoValidateAntiforgeryToken]
[PublicStore(true)]
+ [ProducesResponseType(typeof(PasswordRecoveryModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> PasswordRecovery(PasswordRecoveryModel model)
{
if (!ModelState.IsValid) return View(model);
@@ -376,6 +379,7 @@ public class AccountController : BasePublicController
[HttpGet]
[PublicStore(true)]
+ [ProducesResponseType(typeof(PasswordRecoveryConfirmModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> PasswordRecoveryConfirm(string token, string email)
{
var customer = await _customerService.GetCustomerByEmail(email);
@@ -415,6 +419,7 @@ public class AccountController : BasePublicController
//available even when navigation is not allowed
[PublicStore(true)]
[HttpGet]
+ [ProducesResponseType(typeof(RegisterModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> Register()
{
//check whether registration is allowed
@@ -623,6 +628,7 @@ public class AccountController : BasePublicController
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerInfoModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> Info()
{
var model = await _mediator.Send(new GetInfo {
@@ -637,6 +643,7 @@ public class AccountController : BasePublicController
[HttpPost]
[AutoValidateAntiforgeryToken]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerInfoModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> Info(CustomerInfoModel model)
{
if (ModelState.IsValid)
@@ -710,6 +717,7 @@ public class AccountController : BasePublicController
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerAddressListModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> Addresses()
{
var model = await _mediator.Send(new GetAddressList {
@@ -743,6 +751,7 @@ public class AccountController : BasePublicController
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerAddressEditModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> AddressAdd()
{
var countries =
@@ -766,6 +775,7 @@ public class AccountController : BasePublicController
[HttpPost]
[AutoValidateAntiforgeryToken]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(AddressModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> AddressAdd(CustomerAddressEditModel model,
[FromServices] AddressSettings addressSettings)
{
@@ -803,6 +813,7 @@ public class AccountController : BasePublicController
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerAddressEditModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> AddressEdit(string addressId)
{
var customer = _workContextAccessor.WorkContext.CurrentCustomer;
@@ -831,6 +842,8 @@ public class AccountController : BasePublicController
[HttpPost]
[AutoValidateAntiforgeryToken]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerAddressEditModel), StatusCodes.Status200OK)]
+
public virtual async Task<IActionResult> AddressEdit(CustomerAddressEditModel model,
[FromServices] AddressSettings addressSettings)
{
diff --git a/src/Web/Grand.Web/Controllers/ActionCartController.cs b/src/Web/Grand.Web/Controllers/ActionCartController.cs
index b6d450b23..d8e2498ee 100644
--- a/src/Web/Grand.Web/Controllers/ActionCartController.cs
+++ b/src/Web/Grand.Web/Controllers/ActionCartController.cs
@@ -8,6 +8,7 @@ using Grand.Domain.Catalog;
using Grand.Domain.Common;
using Grand.Domain.Orders;
using Grand.Infrastructure;
+using Grand.SharedKernel.Attributes;
using Grand.Web.Common.Controllers;
using Grand.Web.Common.Filters;
using Grand.Web.Extensions;
@@ -15,6 +16,7 @@ using Grand.Web.Features.Models.Products;
using Grand.Web.Features.Models.ShoppingCart;
using Grand.Web.Models.ShoppingCart;
using MediatR;
+using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using System.Globalization;
@@ -22,6 +24,7 @@ using System.Globalization;
namespace Grand.Web.Controllers;
[DenySystemAccount]
+[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
public class ActionCartController : BasePublicController
{
#region CTOR
@@ -162,6 +165,7 @@ public class ActionCartController : BasePublicController
#region Public methods
+ [ProducesResponseType(typeof(ProductCatalogCart), StatusCodes.Status200OK)]
[HttpPost]
public virtual async Task<IActionResult> AddProductCatalog(ProductCatalogCart model)
{
@@ -315,6 +319,7 @@ public class ActionCartController : BasePublicController
}
}
+ [ProducesResponseType(typeof(ProductDetailsCart), StatusCodes.Status200OK)]
[HttpPost]
public virtual async Task<IActionResult> AddProductDetails(ProductDetailsCart model)
{
@@ -515,6 +520,7 @@ public class ActionCartController : BasePublicController
#endregion
}
+ [ProducesResponseType(typeof(ProductDetailsCart), StatusCodes.Status200OK)]
[HttpPost]
public virtual async Task<IActionResult> UpdateItemCart(ProductDetailsCart model)
{
@@ -651,7 +657,7 @@ public class ActionCartController : BasePublicController
message = ""
});
}
-
+
[HttpGet]
public virtual async Task<IActionResult> GetItemCart(string shoppingCartId)
{
@@ -703,6 +709,7 @@ public class ActionCartController : BasePublicController
});
}
+ [ProducesResponseType(typeof(AddBidModel), StatusCodes.Status200OK)]
[HttpPost]
public virtual async Task<IActionResult> AddBid(AddBidModel model,
[FromServices] IAuctionService auctionService)
diff --git a/src/Web/Grand.Web/Controllers/OrderController.cs b/src/Web/Grand.Web/Controllers/OrderController.cs
index 71f3429f4..ab21431e3 100644
--- a/src/Web/Grand.Web/Controllers/OrderController.cs
+++ b/src/Web/Grand.Web/Controllers/OrderController.cs
@@ -21,6 +21,7 @@ using Grand.Web.Extensions;
using Grand.Web.Features.Models.Orders;
using Grand.Web.Models.Orders;
using MediatR;
+using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace Grand.Web.Controllers;
@@ -70,6 +71,7 @@ public class OrderController : BasePublicController
//My account / Orders
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(OrderPagingModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> CustomerOrders(OrderPagingModel command)
{
var model = await _mediator.Send(new GetCustomerOrderList {
@@ -83,6 +85,7 @@ public class OrderController : BasePublicController
//My account / Order details page
[HttpGet]
+ [ProducesResponseType(typeof(OrderDetailsModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> Details(string orderId)
{
var order = await _orderService.GetOrderById(orderId);
@@ -136,6 +139,7 @@ public class OrderController : BasePublicController
//My account / Order details page / Add order note
[HttpPost]
[AutoValidateAntiforgeryToken]
+ [ProducesResponseType(typeof(AddOrderNoteModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> AddOrderNote(AddOrderNoteModel model)
{
if (!_orderSettings.AllowCustomerToAddOrderNote)
@@ -195,6 +199,7 @@ public class OrderController : BasePublicController
//My account / Order details page / Shipment details page
[HttpGet]
+ [ProducesResponseType(typeof(ShipmentDetailsModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> ShipmentDetails(string shipmentId,
[FromServices] IShipmentService shipmentService)
{
@@ -219,6 +224,7 @@ public class OrderController : BasePublicController
//My account / Loyalty points
[HttpGet]
[CustomerGroupAuthorize(SystemCustomerGroupNames.Registered)]
+ [ProducesResponseType(typeof(CustomerLoyaltyPointsModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> CustomerLoyaltyPoints(
[FromServices] LoyaltyPointsSettings loyaltyPointsSettings)
{
diff --git a/src/Web/Grand.Web/Controllers/ProductController.cs b/src/Web/Grand.Web/Controllers/ProductController.cs
index 74e27182a..6b6732c38 100644
--- a/src/Web/Grand.Web/Controllers/ProductController.cs
+++ b/src/Web/Grand.Web/Controllers/ProductController.cs
@@ -24,6 +24,8 @@ using Grand.Web.Models.Catalog;
using MediatR;
using Microsoft.AspNetCore.Mvc;
using Grand.SharedKernel.Attributes;
+using Grand.Web.Models.Orders;
+using Microsoft.AspNetCore.Http;
namespace Grand.Web.Controllers;
@@ -268,6 +270,7 @@ public class ProductController : BasePublicController
#region Product details page
[HttpGet]
+ [ProducesResponseType(typeof(ProductDetailsModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> ProductDetails(string productId)
{
var product = await _productService.GetProductById(productId);
@@ -334,6 +337,7 @@ public class ProductController : BasePublicController
//handle product attribute selection event. this way we return new price, overridden gtin/sku/mpn
//currently we use this method on the product details pages
[HttpPost]
+ [ProducesResponseType(typeof(ProductDetailsModel), StatusCodes.Status200OK)]
public virtual async Task<IActionResult> ProductDetails_AttributeChange(ProductModel model)
{
var product = await _productService.GetProductById(model.ProductId);
diff --git a/src/Web/Grand.Web/Controllers/VendorController.cs b/src/Web/Grand.Web/Controllers/VendorController.cs
index 82e4fff3b..955cfeff7 100644
--- a/src/Web/Grand.Web/Controllers/VendorController.cs
+++ b/src/Web/Grand.Web/Controllers/VendorController.cs
@@ -24,7 +24,7 @@ using Microsoft.AspNetCore.Mvc;
namespace Grand.Web.Controllers;
-[ApiGroup(SharedKernel.Extensions.ApiConstants.ApiGroupNameV2)]
+[ApiGroup(ApiConstants.ApiGroupNameV2)]
public class VendorController : BasePublicController
{
#region Constructors