web-dev-qa-db-ja.com

ASP.NET Web API Urlを作成する方法は?

ASP.NET MVCには、アクション用の@Url.Actionがあります。/api/controllerにルーティングされる@Url.Apiのような類似のものはありますか?

116

ApiController には rl というタイプのプロパティがあります System.Web.Http.Routing.UrlHelper これにより、APIコントローラーのURLを作成できます。

例:

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ルートがGlobal.asaxのRegisterRoutesメソッドでDefaultApiと呼ばれることを前提としています。

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

Url.Actionのより単純な形式で動作するため、ルーティング名を参照する必要はありません。

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

URLがエリア内で必要な場合は、area = ""を追加できます。 (Apiコントローラーはデフォルトでエリアの外にあります。)MVC 4を使用しています。

44
Gábor Imre

ハードコーディングされた文字列(コントローラー名)なしで、タイプセーフな方法でリンクを生成できるようにしたいですか?

そのためのナゲットがあります! (そして、それはマーク・シーマンによって書かれています)

https://github.com/ploeh/Hyprlinkr

このように動作します:

通常のルート:

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

URLを取得:

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

結果:

http://localhost/api/foo/1337
6

質問に答えるためのKISSメソッドは次のとおりです。

これがMVCコントローラーURLの作成に使用するコードである場合

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

コントローラーのAPIバージョンのURLを取得するには(同じコントローラー名を使用すると仮定)、次を使用できます。

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

Url.Actionメソッドが実行しているのは、アプリケーションのルートパスにコントローラー名を追加し、その後にアクション名を追加することです(「インデックス」である場合を除き、追加されません。ルート値オブジェクトにidがある場合プロパティ値もURLに追加されます。

3
James Bunch