Web API中的多态性:单端点可能吗?

时间:2012-11-28 16:18:11

标签: asp.net-web-api

我意识到Web API是以REST为重点的,但我仍然希望配置一个可以处理命令/响应方案的控制器方法。到目前为止,我还没有成功......有没有办法让单个API端点识别以下类结构?

[Serializable]
public abstract class Command{
    public int CommandId{get; set;}
}
[Serializable]
public class RegisterNewPersonCommand:Command{
   public string Name{get; set;}
}
//etc... various Command subclasses. Similar thing for Responses.

//now have a single endpoint to Handle Commands
public class CommandsController : ApiController{
   public Response HandleCommand(Command command){
      //handle Command based on which subclass it is
      //return appropriate Response subclass
   }
}

到目前为止,序列化系统似乎无法处理这种情况,但我希望有人能找到一种方法:)

1 个答案:

答案 0 :(得分:14)

为了使多态在Web API中工作,您需要启用类型名称处理,并且数据必须包含类型信息。

如果您在方案中使用JSON,则需要在TypeNameHandling中启用WebApiConfig.cs

config.Formatters.JsonFormatter.SerializerSettings.TypeNameHandling = 
    Newtonsoft.Json.TypeNameHandling.All;

然后,您要发送到HandleCommand(...)操作的内容正文必须包含类型信息:

{"$type":"MvcApplication.Models.RegisterNewPersonCommand, MvcApplication", ... }

对于XML,您需要使用DataContract的KnownType ...

顺便提一下,您使用[Serializable]是否有任何具体原因(因为POCO类型和[DataContract]类型也受支持...)?