MB.ResponseResult
1.1.0.1
dotnet add package MB.ResponseResult --version 1.1.0.1
NuGet\Install-Package MB.ResponseResult -Version 1.1.0.1
<PackageReference Include="MB.ResponseResult" Version="1.1.0.1" />
<PackageVersion Include="MB.ResponseResult" Version="1.1.0.1" />
<PackageReference Include="MB.ResponseResult" />
paket add MB.ResponseResult --version 1.1.0.1
#r "nuget: MB.ResponseResult, 1.1.0.1"
#:package MB.ResponseResult@1.1.0.1
#addin nuget:?package=MB.ResponseResult&version=1.1.0.1
#tool nuget:?package=MB.ResponseResult&version=1.1.0.1
MB.ResponseResult Package 📦
A standardized API response library for ASP.NET Core, featuring multi-language support and seamless integration.
👅 Installation
dotnet add package MB.ResponseResult
🚀 Quick Start
- Register Services (Program.cs)
#Basic Usage#
builder.Services.AddResponseResultServices();
Or
#Multiple-Language Support#
builder.Services.AddResponseResultServices(options =>
{
options.IsMultipleLang = true; // Enable multi-language support
});
🎯 Response Breakdown
✅ Success Helpers (Built with ResponseSuccess)
Method | Status Code | Example |
---|---|---|
Created() |
201 | ApiResponse.Created(product) |
Ok(data) |
200 | ApiResponse.Ok(user) |
NoContent() |
204 | ApiResponse.NoContent() |
❌ Error Helpers (Built with ResponseFail)
Method | Status Code | Example |
---|---|---|
NotFound() |
404 | ApiResponse.NotFound("User not found") |
BadRequest() |
400 | ApiResponse.BadRequest(errors) |
ValidationError() |
422 | ApiResponse.ValidationError(errors) |
InternalServerError() |
500 | ApiResponse.InternalServerError() |
🔧 Core Methods
Method | Status Code | Parameters | Example |
---|---|---|---|
ResponseSuccess() |
Custom | statusCode , message , data |
ApiResponse.ResponseSuccess(HttpStatusCode.Accepted, "Processing", data) |
ResponseFail() |
Custom | statusCode , message , errors , data |
ApiResponse.ResponseFail(HttpStatusCode.TooManyRequests, "Rate limited", errors) |
🔑 Key Features
Standardized Format
All responses follow the same consistent structure:
{
"data": {}, // Response payload (object)
"message": "Operation succeeded", // Human-readable message
"statusCode": 200, // HTTP status code
"status": true, // Boolean success indicator
"errors": [] // List of errors (if any)
}
Seamless Conversion
Convert ApiResponse to IActionResult automatically using:
.AsResult()
for synchronous responses : ApiResponse.Ok().AsResult();
.AsResultAsync()
for asynchronous responses : ApiResponse.Ok().AsResultAsync();
🌍 Localization (Multi-Language Support)
Localization Ready
Message keys like "Ok"
or "NotFound"
can be localized by implementing IResultLocalizationService
.
1.Implement a IResultLocalizationService Localization Service
public class CustomLocalizationService : IResultLocalizationService
{
public string GetLocalizedMessage(string messageKey, string languageCode)
{
//Your own logic
}
public Task<string> GetLocalizedMessageAsync(string messageKey, string languageCode)
{
//Your own logic
}
}
2.Register the service in the program.cs
builder.Services.AddScoped<IResultLocalizationService, CustomLocalizer>();
This README provides a quick guide to integrate and use the package effectively. Expand the documentation for advanced scenarios. 😊
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net9.0
- Microsoft.AspNetCore.Mvc.Core (>= 2.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.