Handle API responses generically

Author: acoumb

src/Umbraco.Cms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/ActiveCampaignControllerBase.cs

@@ -1,11 +1,13 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
 using System.Net;
 using System.Text.Json;
 using System.Text.Json.Nodes;
 using Umbraco.Cms.Api.Common.Attributes;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Configuration;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Cms.Web.Common.Authorization;
 using Umbraco.Cms.Web.Common.Routing;
 
 namespace Umbraco.Cms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers
@@ -29,7 +31,7 @@ public ActiveCampaignControllerBase(IOptions<ActiveCampaignSettings> options, IH
             HttpClientFactory = httpClientFactory;
         }
 
-        protected async Task<IActionResult> HandleResponseAsync(HttpResponseMessage? httpResponse)
+        protected async Task<IActionResult> HandleResponseAsync<T>(HttpResponseMessage? httpResponse)
         {
             if (httpResponse is null)
             {
@@ -40,7 +42,7 @@ protected async Task<IActionResult> HandleResponseAsync(HttpResponseMessage? htt
 
             if (httpResponse.IsSuccessStatusCode)
             {
-                return Ok(new JsonResult(JsonSerializer.Deserialize<FormCollectionResponseDto>(content)));
+                return Ok(JsonSerializer.Deserialize<T>(content));
             }
 
             var responseMessage = content.Contains("message") 

src/Umbraco.Cms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/GetFormByIdController.cs

@@ -2,8 +2,6 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
-using System.Text.Json;
-using System.Text.Json.Nodes;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Configuration;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Models.Dtos;
 
@@ -19,6 +17,9 @@ public GetFormByIdController(IOptions<ActiveCampaignSettings> options, IHttpClie
 
         [HttpGet("forms/{id}")]
         [ProducesResponseType(typeof(FormResponseDto), StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
+        [ProducesResponseType(StatusCodes.Status500InternalServerError)]
         public async Task<IActionResult> GetForm(string id)
         {
             var client = HttpClientFactory.CreateClient(Constants.FormsHttpClient);
@@ -30,7 +31,7 @@ public async Task<IActionResult> GetForm(string id)
                     RequestUri = new Uri($"{client.BaseAddress}{ApiPath}/{id}")
                 });
 
-            return await HandleResponseAsync(response);
+            return await HandleResponseAsync<FormResponseDto>(response);
         }
     }
 }

src/Umbraco.Cms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/GetFormsPagedController.cs

@@ -2,8 +2,6 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
-using System.Text.Json;
-using System.Text.Json.Nodes;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Configuration;
 using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Models.Dtos;
 
@@ -19,7 +17,10 @@ public GetFormsByPageController(IOptions<ActiveCampaignSettings> options, IHttpC
 
         [HttpGet("forms")]
         [ProducesResponseType(typeof(FormCollectionResponseDto), StatusCodes.Status200OK)]
-        public async Task<IActionResult> GetForms([FromQuery]int page = 1)
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
+        [ProducesResponseType(StatusCodes.Status500InternalServerError)]
+        public async Task<IActionResult> GetForms([FromQuery]int? page = 1)
         {
             var client = HttpClientFactory.CreateClient(Constants.FormsHttpClient);
 
@@ -35,7 +36,7 @@ public async Task<IActionResult> GetForms([FromQuery]int page = 1)
 
             var response = await client.SendAsync(requestMessage);
 
-            return await HandleResponseAsync(response);
+            return await HandleResponseAsync<FormCollectionResponseDto>(response);
         }
     }
 }