如何使用IHttpActionResult对Created-201响应进行编码

时间:2014-05-27 14:39:17

标签: c# asp.net asp.net-web-api response asp.net-web-api2

如何使用IHttpActionResult

对Created-201响应进行编码

IHttpActionResult只有这些选项

  • 好的
  • 列表项
  • NotFound
  • 例外
  • 未经授权
  • 错误请求
  • 冲突重定向
  • InvalidModelState

我现在正在做的是下面的代码,但我想使用IHttpActionResult而不是HttpResponseMessage

 public IHttpActionResult Post(TaskBase model)
        {
           HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.Created, model);
          response.Headers.Add("Id", model.Id.ToString());
          return ResponseMessage(response);
         }

4 个答案:

答案 0 :(得分:14)

如果您的视图派生自ApiController,您应该能够从基类调用Created方法来创建此类响应。

样品:

[Route("")]
public async Task<IHttpActionResult> PostView(Guid taskId, [FromBody]View view)
{
    // ... Code here to save the view

    return Created(new Uri(Url.Link(ViewRouteName, new { taskId = taskId, id = view.Id })), view);
}

答案 1 :(得分:5)

return Content(HttpStatusCode.Created, "Message");

内容正在返回NegotiatedContentResult。 NegotiatedContentResult实现了IHttpActionResult。

enter image description here

enter image description here

类似的问题:如果你想发送带有消息的NotFound。

return Content(HttpStatusCode.NotFound, "Message");

或者:

return Content(HttpStatusCode.Created, Class object);
return Content(HttpStatusCode.NotFound, Class object);

答案 2 :(得分:3)

在ASP.NET Core中,应该返回IActionResult。这意味着您可以返回带有201状态代码的ObjectResult

[HttpPost]
public async Task<IActionResult> PostAsync([FromBody] CreateModel createModel)
{
    // Create domain entity and persist
    var entity = await _service.Create(createModel);

    // Return 201
    return new ObjectResult(entity) { StatusCode = StatusCodes.Status201Created };
}

答案 3 :(得分:-1)

我知道这是一个旧帖子,但你可能想看看我的解决方案here。它比需要的多一点,但肯定能做到这一点。

<强>步骤:

定义自定义属性:

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public sealed class UniqueIdAttribute: Attribute
    {
    }

使用自定义属性装饰模型的唯一标识属性:

   public class Model
    {
        public List<Model> ChildModels { get; set; }
        [UniqueId]
        public Guid ModelId { set; get; }
        public Guid ? ParentId { set; get; }
        public List<SomeOtherObject> OtherObjects { set; get; }
    }

将新的Created(T yourobject);方法添加到继承自ApiController的BaseController。从这个BaseController继承所有控制器:

CreatedNegotiatedContentResult<T> Created<T>(T content)
    {
        var props =typeof(T).GetProperties()
        .Where(prop => Attribute.IsDefined(prop, typeof(UniqueIdAttribute)));
        if (props.Count() == 0)
        {
            //log this, the UniqueId attribute is not defined for this model
            return base.Created(Request.RequestUri.ToString(), content);
        }
        var id = props.FirstOrDefault().GetValue(content).ToString();
        return base.Created(new Uri(Request.RequestUri + id), content);
     }

它非常简单,无需担心在每种方法中都写得那么多。您所要做的就是致电Created(yourobject);

如果您忘记装饰或无法装饰模型(由于某种原因),Created()方法仍然有效。虽然位置标题会遗漏Id。

您对该控制器的单元测试应该注意这一点。