feat: Swagger examples

Author: drwatson1

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/App_Start/Profiles/DefaultProfile.cs

@@ -7,6 +7,7 @@ public class DefaultProfile: Profile
         public DefaultProfile()
         {
             CreateMap<Model.Product, Dto.Product>();
+            CreateMap<Dto.UpdateProduct, Model.Product>();
             // For copy creation
             CreateMap<Model.Product, Model.Product>();
         }

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Controllers/ProductsController.cs

@@ -9,6 +9,9 @@
 
 namespace ReferenceProject.Controllers
 {
+    /// <summary>
+    /// Products Controller
+    /// </summary>
     [Route("[controller]")]
     [ApiController]
     [Produces("application/json")]
@@ -26,18 +29,18 @@ public ProductsController(Repo.IProductsRepo productsRepo, IMapper mapper)
         /// <summary>
         /// Get all products
         /// </summary>
-        /// <response code="200">List of all of the products</response>
+        /// <response code="200">List of all products</response>
         [HttpGet]
         public IEnumerable<Dto.Product> Get()
         {
             return ProductsRepo.Get().Select(Mapper.Map<Dto.Product>);
         }
 
         /// <summary>
-        /// Get product by id
+        /// Get a product by id
         /// </summary>
-        /// <param name="id">Product id</param>
-        /// <response code="200">Product with the specified id</response>
+        /// <param name="id">A product id</param>
+        [ProducesResponseType(typeof(Dto.Product), StatusCodes.Status200OK)]
         [ProducesResponseType(StatusCodes.Status404NotFound)]
         [HttpGet]
         [Route("{id}")]
@@ -46,6 +49,56 @@ public Dto.Product GetById(int id)
             return Mapper.Map<Dto.Product>(ProductsRepo.GetById(id));
         }
 
+        /// <summary>
+        /// Create a new product
+        /// </summary>
+        /// <param name="id">A new product id</param>
+        /// <param name="newProductDto">New product data</param>
+        /// <response code="201">The created product</response>
+        [ProducesResponseType(typeof(Dto.Product), StatusCodes.Status201Created)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [HttpPost]
+        [Route("{id}")]
+        public IActionResult Create(int id, [FromBody]Dto.UpdateProduct newProductDto)
+        {
+            var newProduct = new Model.Product(id);
+            Mapper.Map(newProductDto, newProduct);
+            ProductsRepo.Create(newProduct);
+            return Created($"{id}", Mapper.Map<Dto.Product>(ProductsRepo.GetById(id)));
+        }
+
+        /// <summary>
+        /// Update a product
+        /// </summary>
+        /// <param name="id">Id of the product to update</param>
+        /// <param name="productDto">Product data</param>
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [HttpPut]
+        [Route("{id}")]
+        public IActionResult Update(int id, [FromBody]Dto.UpdateProduct productDto)
+        {
+            var product = ProductsRepo.GetById(id);
+            Mapper.Map(productDto, product);
+            ProductsRepo.Update(product);
+            return Ok();
+        }
+
+        /// <summary>
+        /// Delete a product
+        /// </summary>
+        /// <param name="id">Id of the product to delete</param>
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [HttpDelete]
+        [Route("{id}")]
+        public IActionResult Delete(int id)
+        {
+            ProductsRepo.Delete(id);
+            return Ok();
+        }
+
         /// <summary>
         /// Example of an exception handling
         /// </summary>

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Controllers/ValuesController.cs

@@ -1,10 +1,15 @@
 namespace ReferenceProject.Dto
 {
     /// <summary>
-    /// Model example: Product
+    /// DTO for reading product (-s)
     /// </summary>
     public class Product
     {
+        /// <summary>
+        /// Product id
+        /// </summary>
+        public int Id { get; set; }
+
         /// <summary>
         /// Product name
         /// </summary>

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Dto/Product.cs

@@ -0,0 +1,13 @@
+namespace ReferenceProject.Dto
+{
+    /// <summary>
+    /// DTO for creating and updating product
+    /// </summary>
+    public class UpdateProduct
+    {
+        /// <summary>
+        /// Product name
+        /// </summary>
+        public string Name { get; set; }
+    }
+}

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Dto/UpdateProduct.cs

@@ -8,6 +8,11 @@ public Product()
         {
         }
 
+        public Product(int id)
+        {
+            Id = id;
+        }
+
         public Product(int id, string name)
         {
             Id = id;

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Model/Product.cs

@@ -34,7 +34,7 @@ public void Create(Product p)
 
             if (products.Any(x => x.Id == p.Id))
             {
-                throw new DuplicateKeyException($"Can't create object of type {nameof(Product)} with the key '{p.Id}'. Object with the same key is already exists");
+                throw new DuplicateKeyException($"Can't create an object of a type {nameof(Product)} with the key '{p.Id}'. The object with the same key is already exists");
             }
 
             products.Add(Mapper.Map<Product>(p));
@@ -45,7 +45,7 @@ public void Delete(int id)
             var p = products.FirstOrDefault(x => x.Id == id);
             if (p == null)
             {
-                throw new KeyNotFoundException($"Object of type '{nameof(Product)}' with the key '{id}' not found");
+                throw new KeyNotFoundException($"An object of a type '{nameof(Product)}' with the key '{id}' not found");
             }
 
             products.RemoveAll(x => x.Id == p.Id);
@@ -59,7 +59,7 @@ public void Update(Product p)
             var stored = products.FirstOrDefault(x => x.Id == p.Id);
             if (stored == null)
             {
-                throw new KeyNotFoundException($"Object of type '{nameof(Product)}' with the key '{p.Id}' not found");
+                throw new KeyNotFoundException($"An object of a type '{nameof(Product)}' with the key '{p.Id}' not found");
             }
 
             products.RemoveAll(x => x.Id == stored.Id);

ProjectTemplates/AspNetCore.WebApi/ReferenceProject/ReferenceProject/Repo/ProductsRepo.cs

@@ -16,10 +16,8 @@
 using ReferenceProject.Modules;
 using System.IO;
 
-// TODO: Create and validate configuration in web.config:
 // https://www.talkingdotnet.com/how-to-increase-file-upload-size-asp-net-core/
 // https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-2.1&tabs=aspnetcore2x#webconfig-file
-
 namespace ReferenceProject
 {
     public class Startup