Code only: New APIs in ProblemDetails to support more resilient integrations

[Rick-Anderson]

Problem details

New APIs in ProblemDetails to support more resilient integrations

Put sample code in https://github.com/dotnet/AspNetCore.Docs/tree/main/aspnetcore/fundamentals/minimal-apis/handle-errrors/sample8

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 457f91a3-57c8-5b11-e060-71f8384ab27d
• Version Independent ID: 457f91a3-57c8-5b11-e060-71f8384ab27d
• Content: Handle errors in Minimal API apps
• Content Source: aspnetcore/fundamentals/minimal-apis/handle-errrors.md
• Product: aspnet-core
• Technology: aspnetcore-fundamentals
• GitHub Login: @brunolins16
• Microsoft Alias: brolivei

---

Associated WorkItem - 76920

[Rick-Anderson]

@Tiscs @martincostello @david-acker @fiyazbinhasan anyone interested in writing a sample showing New APIs in ProblemDetails to support more resilient integrations?

[david-acker]

I'm interested in helping out with this. Should this sample only focus on the new TryWriteAsync API that's mentioned in the blog post?

[brunolins16]

@Rick-Anderson not sure the plan but we have this new feature as well dotnet/aspnetcore#47651

[Rick-Anderson]

I'm interested in helping out with this. Should this sample only focus on the new TryWriteAsync API that's mentioned in the blog post?

Yes, that and the new Exception property.

@david-acker let me know if I can help and if you can take this.

[david-acker]

@Rick-Anderson I've put up a draft PR with a sample using IProblemDetailsService.TryWriteAsync. Right now it just includes a very simple demo of the fallback behavior when used with the UseStatusCodePages and UseExceptionHandler middleware.

Locally, I tested out the fallback behavior by hitting the endpoints with an Accept header that's not supported by the DefaultProblemDetailsWriter (e.g. text/plain). Would it make sense to mention something about this somewhere (either a code comment or in one of the written docs) to give a simple example of a scenario where the fallback behavior would be used?

Since the Exception property on ProblemDetailsContext will be added in the next .NET 8 Preview, do we want to include this in the sample? Or should this be added in a separate PR once .NET Preview 4 is released?

[Rick-Anderson]

@Rick-Anderson I've put up a draft PR with a sample using IProblemDetailsService.TryWriteAsync. Right now it just includes a very simple demo of the fallback behavior when used with the UseStatusCodePages and UseExceptionHandler middleware.

Locally, I tested out the fallback behavior by hitting the endpoints with an Accept header that's not supported by the DefaultProblemDetailsWriter (e.g. text/plain). Would it make sense to mention something about this somewhere (either a code comment or in one of the written docs) to give a simple example of a scenario where the fallback behavior would be used?

Yes, put some code comments in. When we add this to the document, we may move the comments out of code and into the doc.

Since the Exception property on ProblemDetailsContext will be added in the next .NET 8 Preview, do we want to include this in the sample? Or should this be added in a separate PR once .NET Preview 4 is released?

#29126