如何创建ASP.NET Web API Url?

时间:2012-02-29 15:53:51

标签: asp.net-mvc-4 asp.net-web-api

在ASP.NET MVC中,我们有@Url.Action个动作。是否有类似@Url.Api的类似路由到/ api / controller?

4 个答案:

答案 0 :(得分:134)

ApiController有一个名为Url的属性,其类型为System.Web.Http.Routing.UrlHelper,允许您为api控制器构建网址。

示例:

public class ValuesController : ApiController
{
    // GET /api/values
    public IEnumerable<string> Get()
    {
        // returns /api/values/123
        string url = Url.Route("DefaultApi", new { controller = "values", id = "123" });
        return new string[] { "value1", "value2" };
    }

    // GET /api/values/5
    public string Get(int id)
    {
        return "value";
    }

    ...
}

此UrlHelper既不存在于您的视图中,也不存在于标准控制器中。


更新:

为了在ApiController之外进行路由,您可以执行以下操作:

public class HomeController : Controller
{
    public ActionResult Index()
    {
        string url = Url.RouteUrl(
            "DefaultApi", 
            new { httproute = "", controller = "values", id = "123" }
        );
        return View();
    }
}

或在视图中:

<script type="text/javascript">
    var url = '@Url.RouteUrl("DefaultApi", new { httproute = "", controller = "values", id = "123" })';
    $.ajax({
       url: url,
       type: 'GET',
       success: function(result) {
           // ...
       }
    });
</script>

注意httproute = ""路由令牌很重要。

显然,这假设您的Api路线在DefaultApi中的RegisterRoutes方法中被称为Global.asax

routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

答案 1 :(得分:44)

它使用更简单的Url.Action形式,因此您不必引用任何路由名称:

Url.Action("ActionName", "ControllerName", new { httproute = "DefaultApi" })

如果区域内需要URL,您可能需要添加area = ""。 (默认情况下,Api控制器在区域之外。)我正在使用MVC 4.

答案 2 :(得分:6)

希望能够以类型安全的方式生成链接,而不使用硬编码字符串(控制器名称)吗?

为此付出了努力! (并且由Mark Seeman撰写)

https://github.com/ploeh/Hyprlinkr

像这样工作:

路线,像往常一样:

name: "API Default",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }

获取网址:

var linker = new RouteLinker(request);
var uri = linker.GetUri<FooController>(r => r.GetById(1337));

结果:

http://localhost/api/foo/1337

答案 3 :(得分:2)

以下是回答问题的KISS方法:

如果这是您用于创建MVC控制器URL的代码

@Url.Action("Edit", "MyController")

为了获取控制器API版本的URL(假设您使用相同的控制器名称),您可以使用

@Url.Action("Edit", "api/MyController")

所有Url.Action方法正在做的是附加应用程序的根路径,使用控制器名称,后跟操作名称(除非它是“索引”,在这种情况下它不会附加。如果路由值对象有一个id属性,该值也附加到URL。