ApiControllerBase.cs

Go to the documentation of this file.

using System;
using System.Net.Mime;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;
 
namespace Tgstation.Server.Host.Controllers
{
    [Produces(MediaTypeNames.Application.Json)]
    [ApiController]
    public abstract class ApiControllerBase : Controller
    {
        public sealed override async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
        {
            // never cache an API response
            Response.Headers.Add(HeaderNames.CacheControl, new StringValues("no-cache"));
 
            var errorCase = await HookExecuteAction(
                () => base.OnActionExecutionAsync(context, next),
                Request.HttpContext.RequestAborted);
 
            if (errorCase != null)
                await errorCase.ExecuteResultAsync(context);
        }
 
        protected virtual async ValueTask<IActionResult?> HookExecuteAction(Func<Task> executeAction, CancellationToken cancellationToken)
        {
            ArgumentNullException.ThrowIfNull(executeAction);
 
            await executeAction();
            return null;
        }
    }
}