ISC.ApiResponse 1.0.0

ISC.ApiResponse

ISC.ApiResponse is a lightweight .NET library for standardizing API responses across services.

It helps you return a consistent response shape for:

• Success results
• Error results
• Paginated results

Why use this package?

• Keep response contracts consistent across all APIs
• Reduce duplicated response-building code in controllers/services
• Include metadata (requestId, traceId, timestamp) in every response
• Support pagination metadata automatically when using paged data models

Target framework

• .NET 8 (net8.0)

Installation

dotnet add package ISC.ApiResponse

Response structure

Typical response format:

{
  "success": true,
  "data": {},
  "error": null,
  "status": "OK",
  "meta": {
    "requestId": "string",
    "traceId": "string",
    "timestamp": "2026-01-01T00:00:00Z",
    "pagination": null
  }
}

Usage

1) Success response

using ISC.ApiResponse.Models;

var user = new { Id = 1, Name = "Alice" };
var response = ResponseDTO<object>.Ok(user);

// response.Success == true
// response.Status == "OK"

2) Error response

using ISC.ApiResponse.Models;

var response = ResponseDTO<object>.Fail(
    code: "USER_NOT_FOUND",
    message: "The requested user does not exist."
);

// response.Success == false
// response.Error.Code == "USER_NOT_FOUND"

3) Success response with trace identifier

using ISC.ApiResponse.Models;

var payload = new { Message = "Operation completed" };
var response = ResponseDTO<object>.OkResult(payload, traceIdentifier: HttpContext.TraceIdentifier);

4) Paginated response

using ISC.ApiResponse.Models;

var items = new List<string> { "A", "B", "C" };
var paged = new PagedResponse<string>(
    items: items,
    totalCount: 50,
    page: 1,
    limit: 10
);

var response = ResponseDTO<PagedResponse<string>>.OkResult(paged);

// response.Meta.Pagination is populated automatically

Core types

• ResponseDTO<T>: Standard wrapper for API responses
• ApiError: Error code and message
• ApiMeta: Metadata (requestId, traceId, timestamp, pagination)
• PaginationMeta: Pagination details
• PagedResponse<T>: Standard paged list model

Notes

• ApiMeta.Create() generates new IDs if HttpContext.Items["RequestId"] / HttpContext.Items["TraceId"] are not available.
• ResponseDTO<T>.OkResult(...) detects IPagedResult data and fills pagination metadata automatically.

License

This package is provided as-is for internal or public API standardization.