├── .gitignore ├── LICENSE ├── README.md ├── errorhandling-problemdetails-end ├── Controllers │ └── ProductController.cs ├── CustomExceptions │ ├── ProductCustomDetails.cs │ └── ProductCustomException.cs ├── Data │ ├── Context │ │ └── AppDbContext.cs │ └── Models │ │ └── Product.cs ├── ErrorHandlingProblemDetails.csproj ├── ErrorHandlingProblemDetails.sln ├── Program.cs ├── Properties │ └── launchSettings.json ├── Services │ ├── Interfaces │ │ └── IProductService.cs │ └── ProductService.cs ├── Startup.cs ├── appsettings.Development.json └── appsettings.json └── errorhandling-problemdetails-start ├── Controllers └── ProductController.cs ├── Data ├── Context │ └── AppDbContext.cs └── Models │ └── Product.cs ├── ErrorHandlingProblemDetails.csproj ├── ErrorHandlingProblemDetails.sln ├── Program.cs ├── Properties └── launchSettings.json ├── Services ├── Interfaces │ └── IProductService.cs └── ProductService.cs ├── Startup.cs ├── appsettings.Development.json └── appsettings.json /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Code Maze 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Using the ProblemDetails Class in ASP.NET Core Web API 2 | ## https://code-maze.com/using-the-problemdetails-class-in-asp-net-core-web-api 3 | This repo contains the source code for the "Using the ProblemDetails Class in ASP.NET Core Web API" article on Code Maze 4 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Controllers/ProductController.cs: -------------------------------------------------------------------------------- 1 |  2 | using ErrorHandlingProblemDetails.Data.Models; 3 | using ErrorHandlingProblemDetails.Services.Interfaces; 4 | using ErrorHandlingProblemDetails.CustomExceptions; 5 | using Microsoft.AspNetCore.Mvc; 6 | using System.Collections.Generic; 7 | using System.Threading.Tasks; 8 | using System; 9 | 10 | namespace ErrorHandlingProblemDetails.Controllers 11 | { 12 | [Route("api/[controller]")] 13 | [ApiController] 14 | public class ProductController : ControllerBase 15 | { 16 | private readonly IProductService _productService; 17 | public ProductController(IProductService productService) 18 | { 19 | _productService = productService; 20 | } 21 | 22 | [HttpGet] 23 | public async Task> Get() => await _productService.GetAllPrpoducts(); 24 | 25 | [HttpGet("{id}")] 26 | public async Task> GetById(int id) 27 | { 28 | throw new ProductCustomException(Request.Path.Value); 29 | 30 | var product = await _productService.GetProductById(id); 31 | if (product == null) 32 | return NotFound(); 33 | 34 | return Ok(product); 35 | } 36 | 37 | [HttpGet("byName/{name}")] 38 | public async Task> GetByName(string name) 39 | { 40 | throw new Exception("There was an exception while fetching the product"); 41 | 42 | var product = await _productService.GetProductByName(name); 43 | if (product == null) 44 | return NotFound(); 45 | 46 | return Ok(product); 47 | } 48 | 49 | [HttpPost] 50 | public async Task Post([FromBody] Product product) => await _productService.CreateNewProduct(product); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/CustomExceptions/ProductCustomDetails.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | 3 | namespace ErrorHandlingProblemDetails.CustomExceptions 4 | { 5 | public class ProductCustomDetails : ProblemDetails 6 | { 7 | public string AdditionalInfo { get; set; } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/CustomExceptions/ProductCustomException.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace ErrorHandlingProblemDetails.CustomExceptions 4 | { 5 | public class ProductCustomException : Exception 6 | { 7 | public string AdditionalInfo { get; set; } 8 | public string Type { get; set; } 9 | public string Detail { get; set; } 10 | public string Title { get; set; } 11 | public string Instance { get; set; } 12 | 13 | public ProductCustomException(string instance) 14 | { 15 | Type = "product-custom-exception"; 16 | Detail = "There was an unexpected error while fetching the product."; 17 | Title = "Custom Product Exception"; 18 | AdditionalInfo = "Maybe you can try again in a bit?"; 19 | Instance = instance; 20 | } 21 | } 22 | } 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Data/Context/AppDbContext.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Models; 2 | using Microsoft.EntityFrameworkCore; 3 | 4 | namespace ErrorHandlingProblemDetails.Data.Context 5 | { 6 | public class AppDbContext : DbContext 7 | { 8 | public DbSet Products { get; set; } 9 | 10 | public AppDbContext(DbContextOptions options) : base(options) { } 11 | 12 | protected override void OnModelCreating(ModelBuilder builder) 13 | { 14 | base.OnModelCreating(builder); 15 | 16 | builder.Entity().ToTable("Products"); 17 | builder.Entity().HasKey(p => p.Id); 18 | builder.Entity().Property(p => p.Id).IsRequired().ValueGeneratedOnAdd(); 19 | builder.Entity().Property(p => p.Name).IsRequired().HasMaxLength(50); 20 | builder.Entity().Property(p => p.Category).IsRequired().HasMaxLength(20); 21 | 22 | builder.Entity().HasData 23 | ( 24 | new Product { Id = 101, Name = "Plate", Category = "Kitchen Utensils" }, 25 | new Product { Id = 102, Name = "Blanket", Category = "Accessories" }, 26 | new Product { Id = 103, Name = "Bicycle", Category = "Vehicle" } 27 | ); 28 | 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Data/Models/Product.cs: -------------------------------------------------------------------------------- 1 | using System.ComponentModel.DataAnnotations; 2 | 3 | 4 | namespace ErrorHandlingProblemDetails.Data.Models 5 | { 6 | public class Product 7 | { 8 | [Key] 9 | public int Id { get; set; } 10 | [Required(ErrorMessage = "Product name is required")] 11 | public string Name { get; set; } 12 | [StringLength(20, ErrorMessage = "Category name cannot be longer than 20 characters")] 13 | public string Category { get; set; } 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/ErrorHandlingProblemDetails.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net5.0 5 | ErrorHandlingProblemDetails 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/ErrorHandlingProblemDetails.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31025.194 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ErrorHandlingProblemDetails", "ErrorHandlingProblemDetails.csproj", "{1763C52D-62CF-4AA3-B3C6-FC0406762985}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {D8A14164-6D6C-4DA8-8911-FCADC9C4D27A} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Program.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Context; 2 | using Microsoft.AspNetCore; 3 | using Microsoft.Extensions.DependencyInjection; 4 | using Microsoft.AspNetCore.Hosting; 5 | using Microsoft.Extensions.Hosting; 6 | 7 | namespace ErrorHandlingProblemDetails 8 | { 9 | public class Program 10 | { 11 | public static void Main(string[] args) 12 | { 13 | var host = BuildWebHost(args); 14 | 15 | using (var scope = host.Services.CreateScope()) 16 | using (var context = scope.ServiceProvider.GetService()) 17 | { 18 | context.Database.EnsureCreated(); 19 | } 20 | 21 | host.Run(); 22 | } 23 | public static IWebHost BuildWebHost(string[] args) => 24 | WebHost.CreateDefaultBuilder(args) 25 | .UseStartup() 26 | .Build(); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "profiles": { 3 | "ErrorHandlingProblemDetails": { 4 | "commandName": "Project", 5 | "dotnetRunMessages": "true", 6 | "launchBrowser": true, 7 | "launchUrl": "swagger", 8 | "applicationUrl": "https://localhost:5001;http://localhost:5000", 9 | "environmentVariables": { 10 | "ASPNETCORE_ENVIRONMENT": "Development" 11 | } 12 | } 13 | } 14 | } 15 | 16 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Services/Interfaces/IProductService.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Models; 2 | using System.Collections.Generic; 3 | using System.Threading.Tasks; 4 | 5 | namespace ErrorHandlingProblemDetails.Services.Interfaces 6 | { 7 | public interface IProductService 8 | { 9 | Task> GetAllPrpoducts(); 10 | Task GetProductById(int id); 11 | Task CreateNewProduct(Product product); 12 | Task GetProductByName(string name); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Services/ProductService.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Context; 2 | using ErrorHandlingProblemDetails.Data.Models; 3 | using ErrorHandlingProblemDetails.Services.Interfaces; 4 | using Microsoft.EntityFrameworkCore; 5 | using System.Collections.Generic; 6 | using System.Threading.Tasks; 7 | 8 | namespace ErrorHandlingProblemDetails.Services 9 | { 10 | public class ProductService : IProductService 11 | { 12 | protected readonly AppDbContext _context; 13 | 14 | public ProductService(AppDbContext context) 15 | { 16 | _context = context; 17 | } 18 | 19 | public async Task> GetAllPrpoducts() => await _context.Products.ToListAsync(); 20 | 21 | public async Task GetProductById(int id) => await _context.Products.FirstOrDefaultAsync(p => p.Id == id); 22 | 23 | public async Task GetProductByName(string name) => await _context.Products.FirstOrDefaultAsync(p => p.Name == name); 24 | 25 | public async Task CreateNewProduct(Product product) 26 | { 27 | _context.Products.Add(product); 28 | await _context.SaveChangesAsync(); 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/Startup.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.CustomExceptions; 2 | using ErrorHandlingProblemDetails.Data.Context; 3 | using ErrorHandlingProblemDetails.Services; 4 | using ErrorHandlingProblemDetails.Services.Interfaces; 5 | using Hellang.Middleware.ProblemDetails; 6 | using Microsoft.AspNetCore.Builder; 7 | using Microsoft.AspNetCore.Hosting; 8 | using Microsoft.AspNetCore.Http; 9 | using Microsoft.EntityFrameworkCore; 10 | using Microsoft.Extensions.Configuration; 11 | using Microsoft.Extensions.DependencyInjection; 12 | using Microsoft.Extensions.Hosting; 13 | using Microsoft.OpenApi.Models; 14 | 15 | namespace ErrorHandlingProblemDetails 16 | { 17 | public class Startup 18 | { 19 | public Startup(IConfiguration configuration, IWebHostEnvironment env) 20 | { 21 | Configuration = configuration; 22 | CurrentEnvironment = env; 23 | } 24 | 25 | public IConfiguration Configuration { get; } 26 | public IWebHostEnvironment CurrentEnvironment { get; } 27 | 28 | // This method gets called by the runtime. Use this method to add services to the container. 29 | public void ConfigureServices(IServiceCollection services) 30 | { 31 | services.AddProblemDetails(setup => 32 | { 33 | setup.IncludeExceptionDetails = (ctx, env) => CurrentEnvironment.IsDevelopment() || CurrentEnvironment.IsStaging(); 34 | 35 | setup.Map(exception => new ProductCustomDetails 36 | { 37 | Title = exception.Title, 38 | Detail = exception.Detail, 39 | Status = StatusCodes.Status500InternalServerError, 40 | Type = exception.Type, 41 | Instance = exception.Instance, 42 | AdditionalInfo = exception.AdditionalInfo 43 | }); 44 | }); 45 | services.AddControllers(); 46 | 47 | services.AddDbContext(options => 48 | { 49 | options.UseInMemoryDatabase("test-db"); 50 | }); 51 | 52 | services.AddSwaggerGen(c => 53 | { 54 | c.SwaggerDoc("v1", new OpenApiInfo { Title = "ErrorHandlingProblemDetails", Version = "v1" }); 55 | }); 56 | 57 | services.AddScoped(); 58 | } 59 | 60 | // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. 61 | public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 62 | { 63 | app.UseProblemDetails(); 64 | 65 | app.UseSwagger(); 66 | 67 | app.UseSwaggerUI(c => 68 | { 69 | c.SwaggerEndpoint("/swagger/v1/swagger.json", "ErrorHandlingProblemDetails v1"); 70 | }); 71 | 72 | app.UseHttpsRedirection(); 73 | 74 | app.UseRouting(); 75 | 76 | app.UseAuthorization(); 77 | 78 | app.UseEndpoints(endpoints => 79 | { 80 | endpoints.MapControllers(); 81 | }); 82 | } 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-end/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | }, 9 | "AllowedHosts": "*" 10 | } 11 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Controllers/ProductController.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Models; 2 | using ErrorHandlingProblemDetails.Services.Interfaces; 3 | using Microsoft.AspNetCore.Mvc; 4 | using System.Collections.Generic; 5 | using System.Threading.Tasks; 6 | using System; 7 | 8 | namespace ErrorHandlingProblemDetails.Controllers 9 | { 10 | [Route("api/[controller]")] 11 | [ApiController] 12 | public class ProductController : ControllerBase 13 | { 14 | private readonly IProductService _productService; 15 | 16 | public ProductController(IProductService productService) 17 | { 18 | _productService = productService; 19 | } 20 | 21 | [HttpGet] 22 | public async Task> Get() => await _productService.GetAllPrpoducts(); 23 | 24 | [HttpGet("{id}")] 25 | public async Task> GetById(int id) 26 | { 27 | var product = await _productService.GetProductById(id); 28 | if (product == null) 29 | return NotFound(); 30 | 31 | else return Ok(product); 32 | } 33 | 34 | [HttpGet("byName/{name}")] 35 | public async Task> GetByName(string name) 36 | { 37 | throw new Exception("There was an exception while fetching the product"); 38 | 39 | var product = await _productService.GetProductByName(name); 40 | if (product == null) 41 | return NotFound(); 42 | 43 | return Ok(product); 44 | } 45 | 46 | [HttpPost] 47 | public async Task Post([FromBody] Product product) => await _productService.CreateNewProduct(product); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Data/Context/AppDbContext.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Models; 2 | using Microsoft.EntityFrameworkCore; 3 | 4 | namespace ErrorHandlingProblemDetails.Data.Context 5 | { 6 | public class AppDbContext : DbContext 7 | { 8 | public DbSet Products { get; set; } 9 | 10 | public AppDbContext(DbContextOptions options) : base(options) { } 11 | 12 | protected override void OnModelCreating(ModelBuilder builder) 13 | { 14 | base.OnModelCreating(builder); 15 | 16 | builder.Entity().ToTable("Products"); 17 | builder.Entity().HasKey(p => p.Id); 18 | builder.Entity().Property(p => p.Id).IsRequired().ValueGeneratedOnAdd(); 19 | builder.Entity().Property(p => p.Name).IsRequired().HasMaxLength(50); 20 | builder.Entity().Property(p => p.Category).IsRequired().HasMaxLength(20); 21 | 22 | builder.Entity().HasData 23 | ( 24 | new Product { Id = 101, Name = "Plate", Category = "Kitchen Utensils" }, 25 | new Product { Id = 102, Name = "Blanket", Category = "Accessories" }, 26 | new Product { Id = 103, Name = "Bicycle", Category = "Vehicle" } 27 | ); 28 | 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Data/Models/Product.cs: -------------------------------------------------------------------------------- 1 | using System.ComponentModel.DataAnnotations; 2 | 3 | 4 | namespace ErrorHandlingProblemDetails.Data.Models 5 | { 6 | public class Product 7 | { 8 | [Key] 9 | public int Id { get; set; } 10 | [Required(ErrorMessage = "Product name is required")] 11 | public string Name { get; set; } 12 | [StringLength(20, ErrorMessage = "Category name cannot be longer than 20 characters")] 13 | public string Category { get; set; } 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/ErrorHandlingProblemDetails.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net5.0 5 | ErrorHandlingProblemDetails 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/ErrorHandlingProblemDetails.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31025.194 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ErrorHandlingProblemDetails", "ErrorHandlingProblemDetails.csproj", "{1763C52D-62CF-4AA3-B3C6-FC0406762985}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {1763C52D-62CF-4AA3-B3C6-FC0406762985}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {D8A14164-6D6C-4DA8-8911-FCADC9C4D27A} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Program.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Context; 2 | using Microsoft.AspNetCore; 3 | using Microsoft.Extensions.DependencyInjection; 4 | using Microsoft.AspNetCore.Hosting; 5 | using Microsoft.Extensions.Hosting; 6 | 7 | namespace ErrorHandlingProblemDetails 8 | { 9 | public class Program 10 | { 11 | public static void Main(string[] args) 12 | { 13 | var host = BuildWebHost(args); 14 | 15 | using (var scope = host.Services.CreateScope()) 16 | using (var context = scope.ServiceProvider.GetService()) 17 | { 18 | context.Database.EnsureCreated(); 19 | } 20 | 21 | host.Run(); 22 | } 23 | public static IWebHost BuildWebHost(string[] args) => 24 | WebHost.CreateDefaultBuilder(args) 25 | .UseStartup() 26 | .Build(); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "profiles": { 3 | "ErrorHandlingProblemDetails": { 4 | "commandName": "Project", 5 | "dotnetRunMessages": "true", 6 | "launchBrowser": true, 7 | "launchUrl": "swagger", 8 | "applicationUrl": "https://localhost:5001;http://localhost:5000", 9 | "environmentVariables": { 10 | "ASPNETCORE_ENVIRONMENT": "Development" 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Services/Interfaces/IProductService.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Models; 2 | using System.Collections.Generic; 3 | using System.Threading.Tasks; 4 | 5 | namespace ErrorHandlingProblemDetails.Services.Interfaces 6 | { 7 | public interface IProductService 8 | { 9 | Task> GetAllPrpoducts(); 10 | Task GetProductById(int id); 11 | Task CreateNewProduct(Product product); 12 | Task GetProductByName(string name); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Services/ProductService.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Context; 2 | using ErrorHandlingProblemDetails.Data.Models; 3 | using ErrorHandlingProblemDetails.Services.Interfaces; 4 | using Microsoft.EntityFrameworkCore; 5 | using System.Collections.Generic; 6 | using System.Threading.Tasks; 7 | 8 | namespace ErrorHandlingProblemDetails.Services 9 | { 10 | public class ProductService : IProductService 11 | { 12 | protected readonly AppDbContext _context; 13 | 14 | public ProductService(AppDbContext context) 15 | { 16 | _context = context; 17 | } 18 | 19 | public async Task> GetAllPrpoducts() => await _context.Products.ToListAsync(); 20 | 21 | public async Task GetProductById(int id) => await _context.Products.FirstOrDefaultAsync(p => p.Id == id); 22 | 23 | public async Task GetProductByName(string name) => await _context.Products.FirstOrDefaultAsync(p => p.Name == name); 24 | 25 | public async Task CreateNewProduct(Product product) 26 | { 27 | _context.Products.Add(product); 28 | await _context.SaveChangesAsync(); 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/Startup.cs: -------------------------------------------------------------------------------- 1 | using ErrorHandlingProblemDetails.Data.Context; 2 | using ErrorHandlingProblemDetails.Services; 3 | using ErrorHandlingProblemDetails.Services.Interfaces; 4 | using Microsoft.AspNetCore.Builder; 5 | using Microsoft.AspNetCore.Hosting; 6 | using Microsoft.EntityFrameworkCore; 7 | using Microsoft.Extensions.Configuration; 8 | using Microsoft.Extensions.DependencyInjection; 9 | using Microsoft.Extensions.Hosting; 10 | using Microsoft.OpenApi.Models; 11 | 12 | namespace ErrorHandlingProblemDetails 13 | { 14 | public class Startup 15 | { 16 | public Startup(IConfiguration configuration) 17 | { 18 | Configuration = configuration; 19 | } 20 | 21 | public IConfiguration Configuration { get; } 22 | 23 | // This method gets called by the runtime. Use this method to add services to the container. 24 | public void ConfigureServices(IServiceCollection services) 25 | { 26 | 27 | services.AddControllers(); 28 | 29 | services.AddDbContext(options => 30 | { 31 | options.UseInMemoryDatabase("test-db"); 32 | }); 33 | 34 | services.AddSwaggerGen(c => 35 | { 36 | c.SwaggerDoc("v1", new OpenApiInfo { Title = "ErrorHandlingProblemDetails", Version = "v1" }); 37 | }); 38 | 39 | services.AddScoped(); 40 | } 41 | 42 | // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. 43 | public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 44 | { 45 | if (env.IsDevelopment()) 46 | { 47 | app.UseDeveloperExceptionPage(); 48 | 49 | app.UseSwagger(); 50 | 51 | app.UseSwaggerUI(c => 52 | { 53 | c.SwaggerEndpoint("/swagger/v1/swagger.json", "ErrorHandlingProblemDetails v1"); 54 | }); 55 | } 56 | 57 | app.UseHttpsRedirection(); 58 | 59 | app.UseRouting(); 60 | 61 | app.UseAuthorization(); 62 | 63 | app.UseEndpoints(endpoints => 64 | { 65 | endpoints.MapControllers(); 66 | }); 67 | } 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /errorhandling-problemdetails-start/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | }, 9 | "AllowedHosts": "*" 10 | } 11 | --------------------------------------------------------------------------------