为同一端点使用任何类型的内容类型

Question

我有一个asp.net核心（v2.1）webapi项目，它公开了这个函数：

[HttpPost]
[Route("v1/do-something")]
public async Task<IActionResult> PostDoSomething(ModelData model)
{
    //...
}

而这个模型：

public class ModelData
{
    [Required]
    public string Email { get; set; }
}

我希望在内容类型透视图中使此端点具有灵活性。因此，可以在body中发送此端点不同内容类型。

例如，允许那些“BODY”参数：

// application/x-www-form-urlencoded
email="[email protected]"

// application/json
{
    "email": "[email protected]"
}

与旧的.net框架相比，在dotnet核心中，这是不允许开箱即用的。我发现我需要在Consume属性中添加[FormForm]属性。但是，如果我在模型参数中添加[FormForm]属性，它就不再适用于JSON（例如） - 因为它应该是[FromBody]。

我认为可以使用这样的代码：

[HttpPost]
[Route("v1/do-something")]
public async Task<IActionResult> PostDoSomething([FromBody] [FromForm] ModelData model)
{
    //...
}

但正如您所料，此代码无效。

因此，为了实现这种灵活性，我必须复制我的所有端点 - 听起来这是一个非常糟糕的主意。

[HttpPost]
[Route("v1/do-something")]
[Consume ("application/json")]
public async Task<IActionResult> PostDoSomething([FromBody] ModelData model)
{
    //...
}

[HttpPost]
[Route("v1/do-something")]
[Consume ("application/x-www-form-urlencoded")]
public async Task<IActionResult> PostDoSomething([FromForm] ModelData model)
{
    //...
}

// ... Other content types here ...

这听起来很容易。但似乎更复杂。

我错过了什么？如何使端点在任何内容类型中工作？

Answer 1

这是根据内容类型绑定的a custom model binder。

public class BodyOrForm : IModelBinder
{
    private readonly IModelBinderFactory factory;

    public BodyOrForm(IModelBinderFactory factory) => this.factory = factory;

    public async Task BindModelAsync(ModelBindingContext bindingContext)
    {
        var contentType = 
            bindingContext.ActionContext.HttpContext.Request.ContentType;

        BindingInfo bindingInfo = new BindingInfo();
        if (contentType == "application/json")
        {
            bindingInfo.BindingSource = BindingSource.Body;
        }
        else if (contentType == "application/x-www-form-urlencoded")
        {
            bindingInfo.BindingSource = BindingSource.Form;
        }
        else
        {
            bindingContext.Result = ModelBindingResult.Failed();
        }

        var binder = factory.CreateBinder(new ModelBinderFactoryContext
        {
            Metadata = bindingContext.ModelMetadata,
            BindingInfo = bindingInfo,
        });

        await binder.BindModelAsync(bindingContext);
    }
}

测试了以下操作。

[HttpPost]
[Route("api/body-or-form")]
public IActionResult PostDoSomething([ModelBinder(typeof(BodyOrForm))] ModelData model)
{
    return new OkObjectResult(model);
}

这是一个demo is on GitHub。