KamiSama.Chassis.HttpExceptions 10.0.11.2

KamiSama.Chassis.HttpExceptions

Back to package index

Version: 10.0.0

Description

HTTP-oriented exception types with status codes, localization keys, and extra problem details. Use these exceptions to keep application errors consistent across ASP.NET Core APIs.

How to use

dotnet add package KamiSama.Chassis.HttpExceptions --version 10.0.0

Throw an HTTP exception from application or feature code, then let an API-boundary adapter translate its status and localization metadata into a response:

using KamiSama.Chassis.HttpExceptions;

Product product = await repository.FindByIdAsync(id, cancellationToken)
    ?? throw new NotFoundException<Product>(id, nameof(id));

These exceptions only carry metadata; they do not write HTTP responses. ExceptionLocalizationKey and ExceptionLocalizationArguments are intended for a localizing adapter. ExtendedProperties is available to adapters, but the current KamiSamaProblemDetailsProvider does not copy it. GoneException currently reports 401 rather than 410.

Namespaces

• KamiSama.Chassis.HttpExceptions (16 types)

Types

• KamiSama.Chassis.HttpExceptions.AlreadyExistsException - Represents a conflict in which an entity with the supplied key already exists. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.AlreadyExistsException<TEntity> - Represents a conflict in which an entity of type <typeparamref name="TEntity"/> already exists. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.BadRequestException - Represents a client request that cannot be processed and should be reported with HTTP status code 400. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.ConflictException - Represents a request that conflicts with the current resource state and should be reported with HTTP status code 409. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.ForbiddenException - Represents an understood request that the server refuses to perform and should be reported with HTTP status code 403. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.GoneException - Represents a resource that is no longer available. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.HttpExceptionBase - Provides the common HTTP status and localization metadata carried by KamiSama HTTP exceptions. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.InvalidOperationHttpException - Represents an invalid server operation that should be reported with HTTP status code 500. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.NotFoundException - Represents a request for an entity that could not be found. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.NotFoundException<TEntity> - Represents a request for an entity of type <typeparamref name="TEntity"/> that could not be found. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.NotImplementedHttpException - Represents server functionality that is not implemented and should be reported with HTTP status code 501. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.NotSupportedHttpException - Represents an unsupported server operation that should be reported with HTTP status code 500. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.PaymentRequiredException - Represents a request that requires payment and should be reported with HTTP status code 402. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.ServiceUnavailableException - Represents a temporary service outage that should be reported with HTTP status code 503. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.UnAuthorizedException - Represents an unauthenticated request that should be reported with HTTP status code 401. Use it with the surrounding package APIs when composing application code.
• KamiSama.Chassis.HttpExceptions.UnProcessableEntityException - Represents a semantically invalid request that should be reported with HTTP status code 422. Use it with the surrounding package APIs when composing application code.