格式化webapi响应.net核心

Question

我正在创建一个.net核心api。 目前，它运作良好，但是我想在回答中提供更多有用的信息，以便客户可以直接使用这些信息，而找不到正确的方法。

我有一个通用驱动程序，该驱动程序现在返回一个带有三个对象的向量，这些向量包含数据库中流派的信息：

[HttpGet]
        public IEnumerable<Gender> GetAll()
        {
            List<Gender> GenderModel = new List<Gender>();
            genderService.GetGender().ToList().ForEach(u => {
                Gender genero = new Gender
                (
                 u.Id,
                 u.Name
                );
                GenderModel.Add(gender);
            });

            return GenderModel.ToList();
        }

答案如下：

[
  {
    "id": 1,
    "value": "Masculino"
  },
  {
    "id": 2,
    "value": "Femenino"
  },
  {
    "id": 3,
    "value": "Otros"
  }
]

但是，我希望答案具有以下形式：

{
    "results": [
        {
            "id": 0,
            "value: "Otro"
        },
        {
            "id": 1,
            "value": "Masculino"
        },
        {
            "id": 2,
            "value": "Femenino"
        }
    ],
    "info": {
        "results": 3,
        "version": "1.0"
    }
}

显然，您想要添加为其他JSON对象或在info对象中添加的任何其他信息也都必须发送。 我的问题是如何撰写答案。 另一个不太清楚的是，.net核心webapi的响应是矢量格式，其中包含对象，通常，我使用的所有API都是JSON中的响应以及其他JSON对象，我使用时没有问题这种格式在前端，但我对此表示怀疑。

Answer 1

创建POCO类以对api响应进行建模：

        public class ApiResponse{
            public object Results { get; set; }
            public object Info { get; set; }
        }


        //Implementation of ApiResponse
        [HttpGet]
        public ApiResponse GetAll()
        {
                var data = genderService.GetGender().Select(g => 
                 new Gender(){
                   Id = g.Id,
                   Name = g.Name
                 }).ToList();

                var apiResponse = new ApiResponse();
                apiResponse.Results = data;
                apiResponse.Info = new {Results = data.Length, Version = "1.0"};

                return apiResponse;
        }

Answer 2

您应该更改返回对象。 您使用ASP.net核心响应的ActionResult包返回带有状态代码的Json

[HttpPost]        
    public new async Task<IActionResult> Get([FromBody] QueryParams parameters)
    {
            List<Gender> GenderModel = new List<Gender>();
            genderService.GetGender().ToList().ForEach(u => {
                Gender genero = new Gender
                (
                 u.Id,
                 u.Name
                );
                GenderModel.Add(gender);
            });

            return Ok(GenderModel.ToList();
    }

接下来，如果您想在响应中提供更多详细信息，请在

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // do something after the action executes
        // your reponse is in context.response.content 
    }