Как создать URL веб-API ASP.NET?

В ASP.NET MVC мы имеем @Url.Action для действий. Есть ли что-то подобное, как @Url.Api какой маршрут к /api/controller?

Источник

4 ответа

Решение

ApiController имеет свойство Url, имеющее тип System.Web.Http.Routing.UrlHelper, которое позволяет создавать URL-адреса для контроллеров 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 }
);
Источник

Это работает с более простой формой Url.Action таким образом, вам не нужно ссылаться на имена маршрутизации:

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

Вы можете добавить area = "" если URL необходим в области. (Контроллеры Api по умолчанию находятся за пределами области.) Я использую MVC 4.

Источник

Хотите иметь возможность генерировать ссылки в безопасном виде, без жестко закодированных строк (имен контроллеров)?

Для этого есть нюгет! (и это написано Марком Симаном)

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
Источник

Вот метод KISS для ответа на вопрос:

Если это код, который вы использовали бы для создания URL контроллера MVC

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

Чтобы получить URL-адрес для версии API контроллера (при условии, что вы используете то же имя контроллера), вы можете использовать

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

Все, что делает метод Url.Action, - это добавление корневого пути приложения с именем контроллера, за которым следует имя действия (если только это не "индекс", в этом случае он не добавляется. Если объект значений маршрута имеет идентификатор Свойство значение также добавляется к URL.

Источник
Другие вопросы по тегам