Skip to content

Commit ff70fe9

Browse files
committed
Enhance XMLDOC
1 parent e1b1af4 commit ff70fe9

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

src/Initium/Controllers/ApiController.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
namespace Initium.Controllers;
88

99
/// <summary>
10-
/// Base API controller providing global filters and routing.
10+
/// Defines the base API controller within the Initium framework.
11+
/// Applies essential filters such as exception handling, standardized API responses, and request logging.
12+
/// Serves as the primary controller for HTTP API endpoints.
1113
/// </summary>
1214
[ApiController]
1315
[Route("[controller]")]

src/Initium/Controllers/BaseController.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
namespace Initium.Controllers;
44

5-
public class BaseController : ControllerBase
5+
/// <summary>
6+
/// Serves as the foundational controller class in the Initium framework.
7+
/// Provides access to common HTTP request data such as UserId, Client IP, and User-Agent,
8+
/// and includes utility methods for derived API controllers.
9+
/// Intended for general-purpose controller logic across the application.
10+
/// </summary>
11+
public abstract class BaseController : ControllerBase
612
{
713
// protected string? GetClaim(string claimType) => HttpContext.User.Claims.FirstOrDefault(c => c.Type == claimType)?.Value;
814
// protected string UserId => HttpContext.User.Claims.First(claim => claim.Type == "sub").Value;

0 commit comments

Comments
 (0)