C# WebApi 接口返回值不困惑:返回值类型详解

2020-01-05 09:24:50于丽

然后,在API接口里面返回PageResult对象


[HttpGet]
  public IHttpActionResult GetPageRow(int limit, int offset)
  {
   var lstRes = new List<ORDER>();

   //实际项目中,通过后台取到集合赋值给lstRes变量。这里只是测试。
   lstRes.Add(new ORDER() { ID = "aaaa", NO = "111", NAME = "111", DESC = "1111" });
   lstRes.Add(new ORDER() { ID = "bbbb", NO = "222", NAME = "222", DESC = "2222" });

   var oData = new { total = lstRes.Count, rows = lstRes.Skip(offset).Take(limit).ToList() };
   return new PageResult(oData, Request);
  }

最好,ajax调用


$(function () {
 $.ajax({
  type: 'get',
  url: 'http://www.easck.com//向Excel里面填充数据
   HSSFWorkbook workbook = new HSSFWorkbook();
   CreateAndFillSheet(workbook, lstRes);
   
   //保存到服务
   var fileName = "Excel" + DateTime.Now.ToString("yyyyMMddHHmmss") + ".xls";
   var strPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"Data" + fileName);
   using (FileStream fs = new FileStream(strPath, FileMode.Create))
   {
    workbook.Write(fs);
    using (MemoryStream ms = new MemoryStream())
    {
     workbook.Write(ms);
    }
   }

   //输出到浏览器
   try
   {
    var stream = new FileStream(strPath, FileMode.Open);
    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StreamContent(stream);
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
    {
     FileName = fileName
    };

    return response;
   }
   catch
   {
    return new HttpResponseMessage(HttpStatusCode.NoContent);
   }
  }

将文件流保存在StreamContent对象里面,然后输出到浏览器。在浏览器端即可将Excel输出。

四、自定义类型

以上几种返回值类型能解决我们大部分返回值的问题,当然,你也可以将webapi的接口和普通方法一样,返回任意的类型,WebApi会自动序列化你自定义任何返回类型,然后将序列化的值写到响应正文里,状态码统一返回200。比如: