MB.ResponseResult

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

🔧 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)

✅ Success Helpers (Built with ResponseSuccess)

Method	Status Code	Equivalent To	Example
Created()	201	ResponseSuccess(201, message, data)	ApiResponse.Created(product)
Ok(data)	200	ResponseSuccess(200, "Ok", data)	ApiResponse.Ok(user)
NoContent()	204	ResponseSuccess(204, message)	ApiResponse.NoContent()

❌ Error Helpers (Built with ResponseFail)

Method	Status Code	Equivalent To	Example
NotFound()	404	ResponseFail(404, message)	ApiResponse.NotFound("User not found")
BadRequest()	400	ResponseFail(400, message, errors)	ApiResponse.BadRequest(errors)
ValidationError()	422	ResponseFail(422, message, errors)	ApiResponse.ValidationError(errors)
InternalServerError()	500	ResponseFail(500, message)	ApiResponse.InternalServerError()

🔑 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. 😊