Pitasoft.Result 7.0.2

Pitasoft.Result

English | Castellano

English

Pitasoft.Result is a .NET library designed to standardize responses from REST services and internal application layers. It provides a robust set of classes to wrap data, status codes, and error collections, facilitating a unified communication contract between APIs, services, and clients.

Features

• Standardized Responses: Unify your API outputs using Result, ResultEntity<T>, and ResultEntities<T>.
• Fluent Error Handling: Easily add validation errors, exceptions, or business rule violations using a fluent interface.
• Rich Status Management: Built-in StatusResult enum covering common API scenarios (Success, Not Found, Validation Errors, Database Errors, etc.).
• Batch Operations: Specialized support for processing multiple items with ResultBatch<T>.
• Pagination Support: ResultEntities<T> includes metadata like total count, and the library provides PagingParameters for request handling.
• Extensions: Useful helper methods to check for success, specific errors, or state.

Installation

dotnet add package Pitasoft.Result

Core Components

1. Simple Result (Result)

Used for operations that don't return data, only a completion status and optional errors.

public Result DeleteUser(int id)
{
    if (id <= 0) 
        return Result.ValidationError().AddError("id", "Invalid ID");
    
    var deleted = _repository.Delete(id);
    if (!deleted) return Result.NotExists();
    
    return Result.Deleted();
}

2. Result with Entity (ResultEntity<T>)

Used for operations returning a single object.

public ResultEntity<User> GetUser(int id)
{
    var user = _repository.Find(id);
    if (user == null) return ResultEntity<User>.NotExists();
    
    return ResultEntity<User>.Ok(user);
}

3. Result with Multiple Entities (ResultEntities<T>)

Used for lists or paged results. It includes an optional Count property for total records.

public ResultEntities<User> GetUsers(EntityParameters params)
{
    var (users, total) = _repository.GetAll(params);
    return ResultEntities<User>.Ok(users, total);
}

4. Batch Result (ResultBatch<T>)

Used for processing multiple items in a single request, providing a global status and individual results for each item.

public ResultBatch<User> ImportUsers(List<User> users)
{
    var results = users.Select(u => Process(u)).ToList();
    return ResultBatch<User>.Ok(results);
}

Error Handling

The library supports a fluent API for adding errors, which are stored in an ErrorCollection:

return Result.ValidationError()
    .AddError("Email", "Invalid format")
    .AddError("Password", "Too short")
    .AddError(new Exception("Inner system error"));

Status Codes (StatusResult)

Extensions

Import Pitasoft.Result.Extensions to use these helper methods on any IResult:

• result.IsSuccess(): Returns true if status is Ok, Added, Updated, or Deleted.
• result.IsError(): Returns true for most error-related statuses.
• result.IsNotExist(): Returns true if the resource was not found.
• result.HasErrors(): Returns true if there are any errors in the Errors collection.
• result.IsSuccessOrNotExist(): Useful for "Delete" operations where both cases are often handled similarly.

Castellano

Pitasoft.Result es una librería .NET diseñada para estandarizar las respuestas de los servicios REST y las capas internas de la aplicación. Proporciona un conjunto robusto de clases para envolver datos, códigos de estado y colecciones de errores, facilitando un contrato de comunicación unificado entre APIs, servicios y clientes.

Características

• Respuestas Estandarizadas: Unifica las salidas de tu API usando Result, ResultEntity<T> y ResultEntities<T>.
• Gestión de Errores Fluida: Añade fácilmente errores de validación, excepciones o violaciones de reglas de negocio mediante una interfaz fluida.
• Gestión de Estados Enriquecida: Enumerado StatusResult integrado que cubre escenarios comunes (Éxito, No Encontrado, Errores de Validación, Errores de Base de Datos, etc.).
• Operaciones por Lote: Soporte especializado para procesar múltiples elementos con ResultBatch<T>.
• Soporte para Paginación: ResultEntities<T> incluye metadatos como el conteo total, y la librería proporciona PagingParameters para el manejo de peticiones.
• Extensiones: Métodos de ayuda útiles para comprobar éxito, errores específicos o estado.

Instalación

dotnet add package Pitasoft.Result

Componentes Principales

1. Resultado Simple (Result)

Utilizado para operaciones que no devuelven datos, solo un estado de finalización y errores opcionales.

public Result DeleteUser(int id)
{
    if (id <= 0) 
        return Result.ValidationError().AddError("id", "ID no válido");
    
    var deleted = _repository.Delete(id);
    if (!deleted) return Result.NotExists();
    
    return Result.Deleted();
}

2. Resultado con Entidad (ResultEntity<T>)

Utilizado para operaciones que devuelven un único objeto.

public ResultEntity<User> GetUser(int id)
{
    var user = _repository.Find(id);
    if (user == null) return ResultEntity<User>.NotExists();
    
    return ResultEntity<User>.Ok(user);
}

3. Resultado con Múltiples Entidades (ResultEntities<T>)

Utilizado para listas o resultados paginados. Incluye una propiedad opcional Count para el total de registros.

public ResultEntities<User> GetUsers(EntityParameters params)
{
    var (users, total) = _repository.GetAll(params);
    return ResultEntities<User>.Ok(users, total);
}

4. Resultado por Lote (ResultBatch<T>)

Utilizado para procesar múltiples elementos en una sola petición, proporcionando un estado global y resultados individuales para cada elemento.

public ResultBatch<User> ImportUsers(List<User> users)
{
    var results = users.Select(u => Process(u)).ToList();
    return ResultBatch<User>.Ok(results);
}

Gestión de Errores

La librería soporta una API fluida para añadir errores, que se almacenan en una ErrorCollection:

return Result.ValidationError()
    .AddError("Email", "Formato no válido")
    .AddError("Password", "Demasiado corta")
    .AddError(new Exception("Error interno del sistema"));

Códigos de Estado (StatusResult)

Extensiones

Importa Pitasoft.Result.Extensions para usar estos métodos de ayuda en cualquier IResult:

• result.IsSuccess(): Devuelve true si el estado es Ok, Added, Updated o Deleted.
• result.IsError(): Devuelve true para la mayoría de los estados relacionados con errores.
• result.IsNotExist(): Devuelve true si el recurso no fue encontrado.
• result.HasErrors(): Devuelve true si hay algún error en la colección Errors.
• result.IsSuccessOrNotExist(): Útil para operaciones "Delete" donde ambos casos suelen manejarse de forma similar.

License

Copyright © 2019-2026 Pitasoft, S.L. Licensed under the LICENSE.txt provided in this repository.