feat: Add API versioning sample

Author: dobrisa-adamec

src/GettingThingsDone.WebApi/Controllers/ActionV2Controller.cs

@@ -0,0 +1,108 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using GettingThingsDone.ApplicationCore.Helpers;
+using GettingThingsDone.Contracts.Dto;
+using GettingThingsDone.Contracts.Interface;
+using GettingThingsDone.WebApi.Controllers;
+using Microsoft.AspNetCore.Mvc;
+using Serilog;
+using Microsoft.AspNetCore.Mvc.Versioning;
+
+
+namespace GettingThingsDone.WebApiV2.Controllers
+{
+
+    [ApiVersion("2.0")]
+    [Route("api/actions")]
+    [ApiController]
+    public class ActionController: BaseController 
+    {
+        private static class Routes
+        {
+            public const string GetActionById = nameof(GetActionById);
+        }
+
+        private readonly IActionService _actionService;
+
+        public ActionController(IActionService actionService)
+        {
+            _actionService = actionService;
+        }
+
+        [HttpGet]
+        public async Task<ActionResult<List<ActionDto>>> GetAll()
+        {
+            Log.Information("Get all Actions!");
+            return FromValueServiceResult(await _actionService.GetAll());
+        }
+
+        [HttpGet("{id}", Name = Routes.GetActionById)]
+        public async Task<ActionResult<ActionDto>> GetById(int id)
+        {
+            return FromValueServiceResult(await _actionService.GetAction(id));
+        }
+
+        [HttpPost]
+        public async Task<IActionResult> Create([FromBody] ActionDto value)
+        {
+            Log.Warning("Action create {@value}", value);
+
+            if (!value.RepresentsNewEntity)
+                return BadRequest();
+
+            var result = await _actionService.CreateOrUpdate(value);
+
+            if (!result.IsOk())
+                return FromServiceResult(result);
+
+            return CreatedAtRoute(Routes.GetActionById, new { id = result.Value.Id }, result.Value);
+        }
+
+        [HttpPut]
+        public async Task<IActionResult> Update([FromBody] ActionDto value)
+        {
+            if (value.RepresentsNewEntity)
+                return BadRequest();
+
+            var result = await _actionService.CreateOrUpdate(value);
+
+            if (!result.IsOk())
+                return FromServiceResult(result);
+
+            return NoContent();
+        }
+
+        [HttpDelete("{id}")]
+        public async Task<IActionResult> Delete(int id)
+        {
+            var result = await _actionService.Delete(id);
+
+            if (!result.IsOk())
+                return FromServiceResult(result);
+
+            return NoContent();
+        }
+
+        [HttpPut("{id}/move-to/{listId}")]
+        public async Task<IActionResult> MoveToList(int id, int listId)
+        {
+            var result = await _actionService.MoveToList(id, listId);
+
+            if (!result.IsOk())
+                return FromServiceResult(result);
+
+            return NoContent();
+        }
+
+        [HttpPut("{id}/assign-to/{projectId}")]
+        public async Task<IActionResult> AssignToProject(int id, int projectId)
+        {
+            var result = await _actionService.AssignToProject(id, projectId);
+
+            if (!result.IsOk())
+                return FromServiceResult(result);
+
+            return NoContent();
+        }
+    }
+}

src/GettingThingsDone.WebApi/GettingThingsDone.WebApi.csproj

@@ -19,6 +19,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.App" />
     <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="2.1.2" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="2.3.0" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="2.1.1" />
     <PackageReference Include="Serilog.AspNetCore" Version="2.1.1" />
     <PackageReference Include="Serilog.Sinks.File" Version="4.0.0" />

src/GettingThingsDone.WebApi/Startup.cs

@@ -7,6 +7,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Versioning;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Storage;
 using Microsoft.Extensions.Configuration;
@@ -61,6 +62,12 @@ public void ConfigureServices(IServiceCollection services)
             });
             //register OlderThen Handler
             services.AddSingleton<IAuthorizationHandler, OlderThenHandler>();
+            //versioning
+            services.AddApiVersioning(v =>
+            {
+                v.AssumeDefaultVersionWhenUnspecified = true;
+                v.ApiVersionReader = new HeaderApiVersionReader("api-version");
+            });
 
             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
         }