README.md

ProblemDetailsDemo

Overview

Example ASP.Net Core Web API that conforms to the Problem Details spec

Uses Hellang.Middleware.ProblemDetails to implement this spec.

The sample app includes a Swagger UI. Here you can find an explaination of each endpoint: how an MVC action result or raw middleware response is converted to a ProblemDetails response.

Try examples online

1. Browse to : https://hellang-problemdetails-demo.azurewebsites.net
2. Try out the various endpoints using the swagger UI

Try examples locally

1. cd src\ProblemDetailsDemo.Api
2. dotnet run or dotnet run --launch-profile ProblemDetailsDemo.Api.Production
3. Browse to: https://localhost:5001
4. Try out the various endpoints using the swagger UI

Additional resources

• blog post demonstrating nuget library see:
  • https://codeopinion.com/http-api-problem-details-in-asp-net-core/
  • https://andrewlock.net/handling-web-api-exceptions-with-problemdetails-middleware/
• to enrich MS Application Insight request telementry with ProblemDetail data see: https://github.com/christianacca/ApplicationInsights.ProblemDetails

Contributing

• Azure devops home page