https://github.com/christianacca/ProblemDetailsDemo

Example ASP.Net Core Web API that conforms to the Problem Details spec
https://github.com/christianacca/ProblemDetailsDemo

asp-net-core sample-app

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/christianacca/ProblemDetailsDemo
• Owner: christianacca
• License: mit
• Created: 2018-11-22T12:23:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-18T16:17:51.000Z (over 2 years ago)
• Last Synced: 2024-04-30T04:44:51.187Z (almost 2 years ago)
• Topics: asp-net-core, sample-app
• Language: C#
• Homepage: https://problem-details-demo.azurewebsites.net
• Size: 99.6 KB
• Stars: 29
• Watchers: 3
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ProblemDetailsDemo ![Build Status](https://github.com/christianacca/ProblemDetailsDemo/actions/workflows/azure-webapps-dotnet-core.yml/badge.svg)

## Overview

Example ASP.Net Core Web API that conforms to the [Problem Details spec](https://tools.ietf.org/html/rfc7807)

Uses [Hellang.Middleware.ProblemDetails](https://www.nuget.org/packages/Hellang.Middleware.ProblemDetails) to implement this spec.

The sample app includes a [Swagger UI](https://problem-details-demo.azurewebsites.net/swagger). 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 : 

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: 

  * 

  * 

* to enrich MS Application Insight request telementry with ProblemDetail data see: 

## Contributing

* [Github deployments](https://github.com/christianacca/ProblemDetailsDemo/actions/workflows/azure-webapps-dotnet-core.yml)

* [Azure app service](https://portal.azure.com/#@christianaccaazuregmail.onmicrosoft.com/resource/subscriptions/d3f2602d-6ce5-4152-b7ca-082d56b2bf78/resourceGroups/rg-hellang-problemdetails-demo/providers/Microsoft.Web/serverFarms/hellang-problemdetails-demo/webHostingPlan)

  * Entra-ID tenant: 2de591fe-203b-42ed-9c29-15aaa387b978; christianacca.azure@gmail.com