ASP.NET Core API中如何将布尔/整数等简单值转换为JSON？

嘿，这个场景我太熟悉了——之前在做ASP.NET Core API的时候也遇到过同样的需求，既要保持返回格式统一（都是JSON），又不想改动太多现有控制器的写法。最简的实现其实不用搞复杂的过滤器或者中间件，直接利用框架自带的特性就能搞定，分两种情况给你说：

方案1：直接用框架自带的结果方法包装简单值（最简） #

平时我们返回复杂对象时会用return Ok(complexObject);，其实对于布尔值、整数、字符串这类简单值，只要同样用Ok()（或者BadRequest()、NotFound()等对应状态码的方法）包装一下，ASP.NET Core就会自动把它们序列化为JSON格式，而不是返回纯文本，同时还能保留你原本习惯的状态码写法。

举个实际的控制器例子：

[ApiController]
[Route("api/demo")]
public class DemoController : ControllerBase
{
    // 返回布尔值的接口
    [HttpGet("is-healthy")]
    public IActionResult CheckHealth()
    {
        var isHealthy = true;
        return Ok(isHealthy); // 最终返回JSON格式的true，Content-Type为application/json
    }

    // 返回整数的接口
    [HttpGet("total-count")]
    public IActionResult GetTotalCount()
    {
        var count = 100;
        return Ok(count); // 返回JSON格式的100
    }

    // 返回字符串的接口
    [HttpGet("welcome")]
    public IActionResult GetWelcomeMsg()
    {
        var msg = "Hello, API!";
        return Ok(msg); // 返回JSON格式的"Hello, API!"
    }
}

为啥不能直接返回简单值？比如return true;——这时候框架会把它当成纯文本返回，Content-Type是text/plain，前端处理时可能会因为格式不统一出现解析问题，而用Ok()包装就完美解决了这个问题，还完全沿用了你现有的写法。

方案2：如果需要统一的返回结构（带状态码、消息） #

要是你希望所有接口返回都有固定的结构（比如{ "code": 200, "message": "操作成功", "data": xxx }），那也不用复杂操作，定义一个通用的返回模型就行，不管是简单值还是复杂对象，都塞到data字段里：

先定义通用返回模型：

public class ApiResponse<T>
{
    public int Code { get; set; }
    public string Message { get; set; }
    public T Data { get; set; }

    public ApiResponse(int code, string message, T data)
    {
        Code = code;
        Message = message;
        Data = data;
    }
}

// 加个静态辅助类，简化创建过程
public static class ApiResponseHelper
{
    public static ApiResponse<T> Ok<T>(T data)
    {
        return new ApiResponse<T>(StatusCodes.Status200OK, "操作成功", data);
    }

    public static ApiResponse<T> BadRequest<T>(string message, T data = default)
    {
        return new ApiResponse<T>(StatusCodes.Status400BadRequest, message, data);
    }
}

然后控制器里这样用：

[HttpGet("is-healthy")]
public IActionResult CheckHealth()
{
    var isHealthy = true;
    return Ok(ApiResponseHelper.Ok(isHealthy));
}

[HttpGet("get-user")]
public IActionResult GetUser()
{
    var user = new { Id = 1, Name = "Sam" };
    return Ok(ApiResponseHelper.Ok(user));
}

这样不管是简单值还是复杂对象，返回的JSON结构完全统一，而且改动量极小，只是把原来的直接传值改成传ApiResponseHelper.Ok(值)就行。

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