我在尝试对我的Web API进行版本控制时遇到了一些问题:
[ApiVersion("1.0")]
[ApiVersion("2.0")]
[System.Web.Http.Route("api/v{version:apiVersion}/monitors")]
[ControllerName("Monitors")]
public sealed class MonitorsController : ApiController
{
/*
/monitors/get?heartbeat=foo
*/
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
[MapToApiVersion("1.0")]
public JsonResult GetHeartbeatStatusV1(string heartbeat)
{
var x = new JsonResult {Data = "heartbeat v1"};
return x;
}
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
[MapToApiVersion("2.0")]
public JsonResult GetHeartbeatStatusV2(string heartbeat)
{
var x = new JsonResult { Data = "heartbeat v1" };
return x;
}
/*
/monitors/get?alert=foo
*/
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
[MapToApiVersion("2.0")]
public JsonResult GetAlertStatus(string alert)
{
var x = new JsonResult {Data = "alerts"};
return x;
}
/*
/monitors/get?oDataQuery=foo
*/
[System.Web.Http.Route("monitors/get")]
public JsonResult GetODataQuery(string oDataQuery)
{
var x = new JsonResult {Data = "oDataQuery"};
return x;
}
}
以上是我的控制器。我有许多操作,希望能够基于版本调用。
问题在于,我还需要它们都是/get,然后根据参数名称决定调用哪个方法,这就是为什么我有:
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
我原本以为可以在方法上使用
[MapToApiVersion("1.0")]
和 [MapToApiVersion("2.0")]
进行装饰以区分所调用的方法。但是在发布的示例中,如果我调用 api/v1.0/monitors/get?heartbeat=foo
,会出现关于多个操作的错误。如果我调用 v2.0 ,则会显示找不到任何方法。
?
我希望能够执行以下操作
http://foo:blah/api/v1.0/monitors/get?heartbeat=foo
http://foo:blah/api/v2.0/monitors/get?heartbeat=foo
http://foo:blah/api/v2.0/monitors/get?alert=foo
这有可能吗?
编辑
我尝试过将它们拆分成 2 个不同的控制器,并放在不同的命名空间中。
[ApiVersion("2.0")]
[System.Web.Http.Route("api/v{version:apiVersion}/monitors")]
[ControllerName("Monitors")]
public sealed class MonitorsController : ApiController
{
/*
/monitors/get?heartbeat=foo
*/
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
[MapToApiVersion("2.0")]
public JsonResult GetHeartbeatStatusV2(string heartbeat)
{
var x = new JsonResult {Data = "heartbeat v2"};
return x;
}
/*
/monitors/get?alert=foo
*/
[System.Web.Http.Route("api/v{version:apiVersion}/monitors/get")]
public JsonResult GetAlertStatus(string alert)
{
var x = new JsonResult {Data = "alerts"};
return x;
}
}
这个错误是找到多个操作的相同错误。
我的WebApiConfig.cs文件看起来像这样:
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
// Web API configuration and services
// Configure Web API to use only bearer token authentication.
config.SuppressDefaultHostAuthentication();
config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));
var constraintResolver = new DefaultInlineConstraintResolver
{
ConstraintMap =
{
["apiVersion"] = typeof(ApiVersionRouteConstraint)
}
};
config.MapHttpAttributeRoutes(constraintResolver);
config.AddApiVersioning();
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/v{version:apiVersion}/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}
}
http://localhost:53713/api/v2.0/monitors/Getheartbeat?heartbeat=555
时,现在出现一个错误,要求指定版本但未指定。 - Stuart[RoutePrefix("api/V2.0/monitors")]
更改为[RoutePrefix("api/v{version:apiVersion}/monitors")]
来使其正常工作。 - Stuart