/// <summary>
/// Writes machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
/// </summary>
/// <param name="context">The <see cref="HttpContext"/></param>
/// <param name="message">The <see cref="IApiMessage"/></param>
/// <param name="clearCacheHeaders">Clear Cache-Control, Pragma, Expires and ETag headers. Default is true.</param>
/// <returns></returns>
/// <exception cref="InvalidOperationException"></exception>
public static Task WriteProblemDetailsAsync(this HttpContext context, IApiMessage message, bool clearCacheHeaders = true)
{
if (context == null)
{
throw new ArgumentNullException(nameof(context));
}
if (message == null)
{
throw new ArgumentNullException(nameof(message));
}
context.Response.Clear();
if (clearCacheHeaders)
{
context.Response.OnStarting(ClearCacheHeaders, context.Response);
}
context.Response.StatusCode = message.ProblemDetails.Status.GetValueOrDefault((int)HttpStatusCode.InternalServerError);
message.ProblemDetails.Extensions["traceId"] = Activity.Current?.Id ?? context.TraceIdentifier;
string errorText = JsonSerializer.Serialize(message.ProblemDetails, SourceGenerationContext.Default.ProblemDetails);
// https://datatracker.ietf.org/doc/html/rfc7807#section-3
// When serialized as a JSON document, that format is identified with the "application/problem+json" media type.
context.Response.Headers[HeaderNames.ContentType] = "application/problem+json; charset=utf-8";
return(context.Response.WriteAsync(errorText));
}
public ApiResponse(string type, string id, IApiMessage _message)
{
messaging_type = type;
recipient = new Recipient(id);
message = _message;
}
