[英]Web API versioning URL
我试图对我的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;
}
}
以上是我的控制器。 我有一堆我希望能够根据版本调用的动作。
问题是我还需要它们全部/然后根据参数名称决定调用哪个方法,这就是为什么我有:
[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
这可能吗?
编辑
我尝试过的一件事是将它们分成两个不同的控制器,位于不同的命名空间中。
[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 }
);
}
}
你正在做的方式是正确的,但不是使用ApiVersion
属性,你可以使它更简单和可读只是让MapHttpRoute默认,你可以让你的控制器在同一名称空间,只需更改名称MonitorsControllerV2
[RoutePrefix("api/V2.0/monitors")]
public sealed class MonitorsControllerV2 : ApiController
{
/*
/monitors/get?heartbeat=foo
*/
[Route("GetHeartbeat")]
public JsonResult GetHeartbeatStatusV2(string heartbeat)
{
var x = new JsonResult {Data = "heartbeat v2"};
return x;
}
/*
/monitors/get?alert=foo
*/
[Route(" GetAlertStatus")]
public JsonResult GetAlertStatus(string alert)
{
var x = new JsonResult {Data = "alerts"};
return x;
}
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.