有没有一种方法可以用WebAPI生成URL

本文关键字:WebAPI 生成 URL 方法 一种 有没有 | 更新日期: 2023-09-27 18:21:42

在下方编辑

我们无法理解为什么UrlHelper在WebApi控制器的上下文中使用时返回空字符串。

我们已经进行了必要的调试,但我们不知道为什么会发生这种情况,RouteData中有路由,但它似乎不起作用。

在大多数情况下,我们使用RenderViewToString函数,该函数加载由对Url.RouteUrl(routeName)的调用组成的视图。

已经尝试过的是创建一个自定义的UrlHelper(但没有成功),并使用任一UrlHelper的(MVC/HTTP)进行调试。

属性路由与路由名称一起使用。

示例用法代码:

    public class WebApiController : BaseApiController
    {
        [HttpPost]
        [ResponseType(typeof(string))]
        [Route("cart/get/checkout", Name = "api.cart.get.checkout")]
        public IHttpActionResult GetCheckOutShoppingCart([FromBody] string data)
        {
               return Ok(RenderViewToString("CartController", "_CheckOutCartPartial", new ShoppingCartModel(Auth.IsAuthenticated ? Auth.GetCustomer().DefaultShippingInfo.CountryId : 148)
               {
                   AddInsurance = false,
                   InsuredShipping = insuredShipping,
                   CurrentDeliveryMethodId = deliveryMethodId,
                   CurrentPaymentMethodId = paymentMethodId
               }));
        }
   }

BaseApiController类:

 public class BaseApiController : ApiController
    {
        public static string RenderViewToString(string controllerName, string viewName)
        {
            return RenderViewToString(controllerName, viewName, new Dictionary<string, object>());
        }
        public static string RenderViewToString(string controllerName, string viewName, object model)
        {
            using (var writer = new StringWriter())
            {
                var routeData = new RouteData();
                routeData.Values.Add("controller", controllerName);
                var fakeControllerContext =
                    new ControllerContext(
                        new HttpContextWrapper(new HttpContext(new HttpRequest(null, "http://google.com", null),
                            new HttpResponse(null))), routeData, new FakeController());
                var razorViewEngine = new RazorViewEngine();
                var razorViewResult = razorViewEngine.FindView(fakeControllerContext, viewName, "", false);
                var viewContext = new ViewContext(fakeControllerContext, razorViewResult.View,
                    new ViewDataDictionary(model), new TempDataDictionary(), writer);
                razorViewResult.View.Render(viewContext, writer);
                return writer.ToString();
            }
        }
        public static string RenderViewToString(string controllerName, string viewName, Dictionary<string, Object> data)
        {
            using (var writer = new StringWriter())
            {
                var viewData = new ViewDataDictionary();
                foreach (var kv in data)
                {
                    viewData[kv.Key] = kv.Value;
                }
                var routeData = new RouteData();
                routeData.Values.Add("controller", controllerName);
                var fakeControllerContext =
                    new ControllerContext(
                        new HttpContextWrapper(new HttpContext(new HttpRequest(null, "http://google.com", null),
                            new HttpResponse(null))), routeData, new FakeController());
                var razorViewEngine = new RazorViewEngine();
                var razorViewResult = razorViewEngine.FindView(fakeControllerContext, viewName, "", false);
                var viewContext = new ViewContext(fakeControllerContext, razorViewResult.View, viewData,
                    new TempDataDictionary(), writer);
                razorViewResult.View.Render(viewContext, writer);
                return writer.ToString();
            }
        }
        private class FakeController : ControllerBase
        {
            protected override void ExecuteCore()
            {
            }
        }
    }

编辑

我们已经组织了一个理论上应该有效的课程,但事实并非如此。RouteData在集合中同时具有MVC和API路由。

 public static class Url
    {
        public static bool IsWebApiRequest()
        {
            return
                HttpContext.Current.Request.RequestContext.HttpContext.CurrentHandler is
                    System.Web.Http.WebHost.HttpControllerHandler;
        }
        public static string RouteUrl(string routeName, object routeValues = null)
        {
            var url = String.Empty;
            try
            {
                if (IsWebApiRequest())
                {
                    var helper = new System.Web.Http.Routing.UrlHelper();
                    url = helper.Link(routeName, routeValues);             
                }
                else
                {
                    var helper = new System.Web.Mvc.UrlHelper();
                    url = helper.RouteUrl(routeName, routeValues);              
                }
                return url;
            }
            catch
            {
                return url;
            }
        }
        public static string HttpRouteUrl(string routeName, object routeValues = null)
        {
            var url = String.Empty;
            try
            {
                if (IsWebApiRequest())
                {
                    var helper = new System.Web.Http.Routing.UrlHelper();
                    url = helper.Link(routeName, routeValues);
                }
                else
                {
                    var helper = new System.Web.Mvc.UrlHelper();
                    url = helper.HttpRouteUrl(routeName, routeValues);
                }
                return url;
            }
            catch
            {
                return url;
            }
        }
    }

有没有一种方法可以用WebAPI生成URL

这个问题已经通过构建一个自定义的UrlHelper类来解决,该类查看RouteTable,然后返回替换了模式的url。

public static class Link
{
    public static string RouteUrl(string routeName, object routeValues = null)
    {
        var url = String.Empty;
        try
        {
            var route = (Route)RouteTable.Routes[routeName];
            if (route == null)
                return url;
            url = "~/".AbsoluteUrl() + route.Url;
            url = url.Replace("{culture}", System.Threading.Thread.CurrentThread.CurrentCulture.TwoLetterISOLanguageName.ToLower());
            if (routeValues == null) 
                return url;
            var values =  routeValues.GetType().GetProperties();
            Array.ForEach(values, pi => url = Regex.Replace(url, "{" + pi.Name + "}", pi.GetValue(routeValues, null).ToString()));
            return url;
        }
        catch
        {
            var newUrl = RouteUrl("403");
            if(newUrl == String.Empty)
                throw;
            return newUrl;
        }
    }
    public static string HttpRouteUrl(string routeName, object routeValues = null)
    {
       return RouteUrl(routeName, routeValues);
    }
}

尝试Uri.Link(routeName,object)

var uri = Url.Link("api.cart.get.checkout", new { id = 1 });

如果属性名称与路由参数匹配,则会将给定对象的属性注入到路由中。

WebApi不是MVC。尽管它看起来很相似,但却是一个完全不同的系统。

UrlHelper(即MVC)将查看MVC路由表,并忽略任何WebApi路由。

尝试以硬方式创建路由,本质上是将控制器和操作名称硬编码到视图中-(

好的,根据您的评论,您似乎正在尝试从MVC布局.cshtml文件中调用Url.RouteUrl(string routeName, object routeValues = null)Url.HttpRouteUrl(string routeName, object routeValues = null)

如果是这种情况,Url.IsWebApiRequest()将返回false,因为layout.cshtml文件仅作为处理MVC请求的一部分进行处理,而不是WebAPI。这将导致url生成方法使用MVC路由集合,而不是WebAPI集合。

更改Url类,使RouteUrl始终构建WebAPI url,HttpRouteUrl仅构建MVC url,然后在布局文件中根据您在特定上下文中需要的url类型使用适当的方法。

public static class Url
{
    public static bool IsWebApiRequest()
    {
        return
            HttpContext.Current.Request.RequestContext.HttpContext.CurrentHandler is
                System.Web.Http.WebHost.HttpControllerHandler;
    }
    public static string RouteUrl(string routeName, object routeValues = null)
    {
        var url = String.Empty;
        try
        {
            var helper = new System.Web.Http.Routing.UrlHelper();
            return helper.Link(routeName, routeValues);             
        }
        catch
        {
            return url;
        }
    }
    public static string HttpRouteUrl(string routeName, object routeValues = null)
    {
        var url = String.Empty;
        try
        {
            var helper = new System.Web.Mvc.UrlHelper();
            return helper.HttpRouteUrl(routeName, routeValues);
        }
        catch
        {
            return url;
        }
    }
}