ProblemJson 1.0.0

ProblemJson

HttpResponseMessage extensions for detecting, reading, and throwing on application/problem+json responses, as defined by RFC 9457 (Problem Details for HTTP APIs).

Features

• Detect problem responses via the Content-Type header (application/problem+json).
• Deserialize the response body into a strongly-typed ProblemDetails object, including extension members.
• Throw a ProblemDetailsException (derived from HttpRequestException) that carries the parsed problem details.
• Source-generated JSON serialization for trimming/AOT-friendly, allocation-conscious parsing.
• Broad target framework support: .NET Framework 4.6.2, .NET Standard 2.0, .NET 8, .NET 9, and .NET 10.

Installation

Install from NuGet:

dotnet add package ProblemJson

Usage

The extension methods live in the System.Net.Http.Json namespace, so they are available anywhere HttpResponseMessage is already in scope.

Detect a problem response

using System.Net.Http.Json;

using var client = new HttpClient();
using var response = await client.GetAsync("https://api.example.com/orders/42");

if (response.IsProblemJson())
{
    // The body is application/problem+json
}

Read the problem details

ProblemDetails? problem = await response.ReadProblemJsonAsync();
if (problem is not null)
{
    Console.WriteLine($"{problem.Status} {problem.Title}: {problem.Detail}");

    // Access RFC 9457 extension members
    foreach (var extension in problem.Extensions)
        Console.WriteLine($"{extension.Key}: {extension.Value}");
}

You can also supply your own JsonSerializerOptions:

var options = new JsonSerializerOptions(JsonSerializerDefaults.Web);
ProblemDetails? problem = await response.ReadProblemJsonAsync(options);

Both overloads return null when the response is not an application/problem+json payload.

Throw on a problem response

ThrowIfProblemJsonAsync throws a ProblemDetailsException when the body is a problem payload, and returns the same response otherwise for chaining. It does not validate the status code on its own, so continue to call EnsureSuccessStatusCode as needed.

using var response = await client.GetAsync("https://api.example.com/orders/42");

await response.ThrowIfProblemJsonAsync();
response.EnsureSuccessStatusCode();

Handle the exception and inspect the parsed details:

try
{
    await response.ThrowIfProblemJsonAsync();
}
catch (ProblemDetailsException ex)
{
    // ex.Message is derived from Detail, Title, or the HTTP status code
    ProblemDetails? details = ex.ProblemDetails;
}

API

ProblemJsonExtensions

ProblemDetails

A model for the RFC 9457 problem details object.

ProblemDetailsException

Derives from HttpRequestException. The message is derived from the problem's Detail, then Title, then an explicitly supplied message, and finally the HTTP status code. The parsed payload is exposed through the ProblemDetails property. On .NET 5+ the exception's StatusCode is populated from the response.