如何在API处理器中确保ActionResult<T>的类型安全？

问题原因 #

你遇到的情况是因为ActionResult<T>支持从任意ActionResult子类（比如NotFoundResult、OkObjectResult）隐式转换，而ControllerBase.Ok()方法存在接受object参数的重载。当你返回Ok("string")时，会创建一个OkObjectResult，它可以被隐式转换成ActionResult<List<int>>，因此不会触发编译错误。

解决方法 #

方法1：修改Endpoint泛型结果类型为目标数据类型

将Endpoint的泛型参数从ActionResult<List<int>>改为直接使用List<int>，此时HandleAsync的返回类型会自动变为Task<ActionResult<List<int>>>，调用Ok()时必须传入List<int>类型参数，否则会触发编译错误，同时错误状态码（如NotFound()）仍可正常返回。

修改后的代码：

using Ardalis.ApiEndpoints;
using Microsoft.AspNetCore.Mvc;

namespace Path.Goes.Here;

public sealed class Handler : EndpointBaseAsync.WithoutRequest.WithResult<List<int>>
{
    [HttpGet("/my-route")]
    public override async Task<ActionResult<List<int>>> HandleAsync(CancellationToken cancellationToken = new CancellationToken())
    {
        await Task.CompletedTask;

        if (false)
        {
            return NotFound(); // 错误状态码不受影响
        }

        var data = new List<int>() { 1, 2, 3 };

        return Ok(data); // 仅传入List<int>时编译通过
        // return Ok("just a string"); // 此处会触发编译错误，符合预期
    }
}

方法2：直接返回目标数据类型

如果不需要显式调用Ok()（默认返回200状态码），可以直接返回List<int>类型数据，返回类型不匹配时会直接触发编译错误：

public override async Task<ActionResult<List<int>>> HandleAsync(CancellationToken cancellationToken = new CancellationToken())
{
    await Task.CompletedTask;

    if (false)
    {
        return NotFound();
    }

    var data = new List<int>() { 1, 2, 3 };

    return data; // 自动包装为200状态码的响应
    // return "just a string"; // 此处触发编译错误
}

方法3：自定义强类型Ok扩展方法

如果希望保留Ok()调用习惯，可以自定义仅接受目标类型参数的扩展方法，覆盖默认的Ok(object)重载：

public static class ControllerBaseExtensions
{
    public static ActionResult<T> Ok<T>(this ControllerBase controller, T value)
    {
        return controller.Ok((object)value);
    }
}

使用该扩展方法后，传入非List<int>类型参数调用Ok()时会直接触发编译错误，确保返回类型符合预期。

内容的提问来源于stack exchange，提问作者baitendbidz