Added logging

Author: Jennifer Deigendesch

README.md

@@ -5,4 +5,5 @@
   <li>Managing Static Files in ASP.NET Core: https://www.youtube.com/watch?v=n3rL0ekYEOM</li>
   <li>ASP.NET Web API Help Pages using Swagger: https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger</li>
   <li>Middleware und Dependency Injection: https://channel9.msdn.com/Series/Einfhrung-in-ASPNET-Core/02-Middleware-und-Dependency-Injection</li>
+  <li>Logging in ASP.NET Core: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging</li>
 </ul>

src/ASPNETCoreExample/Controllers/FoodController.cs

@@ -6,6 +6,7 @@
 
    using Microsoft.AspNetCore.JsonPatch;
    using Microsoft.AspNetCore.Mvc;
+   using Microsoft.Extensions.Logging;
 
    using Models;
 
@@ -18,12 +19,16 @@
    public class FoodController : Controller {
       private readonly IFoodRepository foodRepository;
 
+      private readonly ILogger logger;
+
       /// <summary>
       /// Constructor
       /// </summary>
       /// <param name="foodRepository">Repository of <see cref="FoodItem"/>.</param>
-      public FoodController(IFoodRepository foodRepository) {
+      /// <param name="logger">Logger of this class.</param>
+      public FoodController(IFoodRepository foodRepository, ILogger<FoodController> logger) {
          this.foodRepository = foodRepository;
+         this.logger = logger;
       }
 
       /// <summary>
@@ -34,7 +39,7 @@ public FoodController(IFoodRepository foodRepository) {
       [HttpGet]
       [ProducesResponseType(typeof(IEnumerable<FoodDto>), 200)]
       public IActionResult GetAllFoodItems() {
-         ICollection<FoodItem> foodItems = this.foodRepository.GetAll();
+         IEnumerable<FoodItem> foodItems = this.foodRepository.GetAll();
          IEnumerable<FoodDto> mappedItems = foodItems.Select(AutoMapper.Mapper.Map<FoodDto>);
 
          return this.Ok(mappedItems);
@@ -54,6 +59,7 @@ public IActionResult GetSingleFoodItem(int id) {
          FoodItem foodItem = this.foodRepository.GetSingle(id);
 
          if (foodItem == null) {
+            this.logger.LogWarning("Item with {ID} not found", id);
             return this.NotFound();
          }
 

src/ASPNETCoreExample/Repositories/FoodRepository.cs

@@ -66,7 +66,7 @@ public FoodItem Update(int id, FoodItem item) {
       /// Get all available <see cref="FoodItem"/>.
       /// </summary>
       /// <returns>Collection of <see cref="FoodItem"/>.</returns>
-      public ICollection<FoodItem> GetAll() {
+      public IEnumerable<FoodItem> GetAll() {
          return this.storage.Values;
       }
 

src/ASPNETCoreExample/Repositories/IFoodRepository.cs

@@ -3,17 +3,48 @@
 
    using Models;
 
+   /// <summary>
+   /// Interface of Repository for <see cref="FoodItem"/>.
+   /// </summary>
    public interface IFoodRepository {
+      /// <summary>
+      /// Get a single <see cref="FoodItem"/> with given <paramref name="id"/>.
+      /// </summary>
+      /// <param name="id">Id of the <see cref="FoodItem"/> to get.</param>
+      /// <returns><see cref="FoodItem"/> with given <paramref name="id"/></returns>
       FoodItem GetSingle(int id);
 
+      /// <summary>
+      /// Add given <see cref="FoodItem"/>.
+      /// </summary>
+      /// <param name="item"><see cref="FoodItem"/> to add.</param>
+      /// <returns>Added <see cref="FoodItem"/>.</returns>
       FoodItem Add(FoodItem item);
 
+      /// <summary>
+      /// Delete <see cref="FoodItem"/> with given <paramref name="id"/>.
+      /// </summary>
+      /// <param name="id">Id of the <see cref="FoodItem"/> to delete.</param>
       void Delete(int id);
 
+      /// <summary>
+      /// Update the values of given <paramref name="item"/> for <see cref="FoodItem"/> with given <paramref name="id"/>.
+      /// </summary>
+      /// <param name="id">Id of the <see cref="FoodItem"/> to update.</param>
+      /// <param name="item">New values of the <see cref="FoodItem"/> to update.</param>
+      /// <returns>Updated <see cref="FoodItem"/>.</returns>
       FoodItem Update(int id, FoodItem item);
 
-      ICollection<FoodItem> GetAll();
+      /// <summary>
+      /// Get all available <see cref="FoodItem"/>.
+      /// </summary>
+      /// <returns>Collection of <see cref="FoodItem"/>.</returns>
+      IEnumerable<FoodItem> GetAll();
 
+      /// <summary>
+      /// Count of <see cref="FoodItem"/> available within the storage.
+      /// </summary>
+      /// <returns>Count of <see cref="FoodItem"/> available within the storage.</returns>
       int Count();
    }
 }

src/ASPNETCoreExample/Startup.cs

@@ -71,7 +71,7 @@ public void ConfigureServices(IServiceCollection services) {
       /// <param name="env"></param>
       /// <param name="loggerFactory"></param>
       public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory) {
-         loggerFactory.AddConsole();
+         loggerFactory.AddConsole(this.Configuration.GetSection("Logging")).AddDebug();
 
          if (env.IsDevelopment()) {
             // Show info about an exception if one occurs only in development environment

src/ASPNETCoreExample/appsettings.json

@@ -4,5 +4,14 @@
   "description": "This is an example of a REST API with ASP.NET Core v1.0",
   "contact-name": "Jennifer Deigendesch",
   "contact-email": "[email protected]",
-  "contact-url": "https://github.com/doubleSlashde/ASPNETCoreExample"
+  "contact-url": "https://github.com/doubleSlashde/ASPNETCoreExample",
+
+  "Logging": {
+    "IncludeScopes": false,
+    "LogLevel": {
+      "Default": "Debug",
+      "System": "Debug",
+      "Microsoft": "Debug"
+    }
+  }
 }

src/ASPNETCoreExample/project.json

@@ -15,7 +15,8 @@
     "Microsoft.AspNetCore.StaticFiles": "1.1.0",
     "Swashbuckle": "6.0.0-beta902",
     "Microsoft.Extensions.Configuration.FileExtensions": "1.0.0",
-    "Microsoft.Extensions.Configuration.Json": "1.0.0"
+    "Microsoft.Extensions.Configuration.Json": "1.0.0",
+    "Microsoft.Extensions.Logging.Debug": "1.0.0"
   },
 
   "tools": {