Problem Details
Problem Details is a standardized HTTP response format for communicating machine-readable information about a problem occurrence, commonly serialized as JSON.
ASP.NET Core in Action, 3e
Problem Details is a standardized structured format for representing HTTP error information in a response body, commonly serialized as JSON.
- How it is used
- Standardizes HTTP API error bodies so mobile apps and single-page applications can consume errors consistently.
- How deep it goes
- Defines fields and demonstrates endpoint helpers, middleware integration, exception conversion, and empty error-body handling.
- Examples
- Uses a fruit API with missing-resource responses, duplicate identifiers, validation dictionaries, exceptions, and empty 404 responses.
- What you can do after
- Build it from scratch using Results helpers and configure middleware to produce consistent Problem Details JSON across an API.
Read how ASP.NET Core in Action, 3e explains Problem Details →
Building Web APIs with ASP.NET Core
ProblemDetails is an object model for representing machine-readable details about an HTTP API error response.
- How it is used
- Standardizes production HTTP API error responses and supports richer exception-handling behavior.
- How deep it goes
- Demonstrates default and customized responses, but stops short of implementing exception-specific status mappings.
- Examples
- Uses an /error endpoint, an /error/test exception, and JSON containing status, detail, type, title, and traceId.
- What you can do after
- Operate/configure ASP.NET Core exception handling to return standardized, traceable JSON error responses.
Read how Building Web APIs with ASP.NET Core explains Problem Details →
Related concepts
- StatusCodePagesMiddlewareproduced by · StatusCodePagesMiddleware is ASP.NET Core middleware that generates or modifies responses for HTTP status codes, including adding a body to error responses that lack one.
- ApiControllerproduced by · ApiController is an ASP.NET Core attribute that enables API-specific conventions and behavior for controller classes, including request binding and validation handling.
- MapGetproduced by · MapGet is an ASP.NET Core endpoint-mapping method that associates HTTP GET requests matching a URL pattern with a handler.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.