0

У меня есть webAPI, в котором у меня много функций. Я хотел бы создать страницу, которая будет описывать api, когда пользователь перейдет к ссылке api.Документ webAPI на веб-странице API

Пример:

У меня есть ссылка: https://coreapi.pexcard.com/v2/Admin/ping

Мой маршрут выглядит следующим образом:

 routes.MapRoute(
      name: "Default", 
      url: "{action}/operation/{page}", 
      defaults: new { controller = "Home", action = "Index", page = "ping" } 
     ); 
     routes.MapRoute(
      name: "DefaultPageView", 
      url: "{action}/", 
      defaults: new { controller = "Home", action="Index", page = "Admin"} 
     ); 
     config.Routes.MapHttpRoute(
      name: "DefaultApi", 
      routeTemplate: "{controller}/{action}", 
      defaults: new { } 
     ); 

Когда пользователь переходит на https://coreapi.pexcard.com/v2/Admin/ я хочу направить их на страницу в моем хранилище который имеет определение API (включая все функции). Я получил это сделано, сделав HomeController следующим образом:

public ActionResult Admin(string page) 
    { 
     return View("Admin/" + page); 
    } 

тогда, когда я иду на сайт я могу получить на веб-страницу, что я положил мое содержание и когда я нажимаю ссылку звона на этой странице (веб-страница в прямом эфире), это приведет меня к описанию пинга.

Я чувствую, что должен быть лучший способ сделать это. Кто-нибудь знает какие-либо встроенные функции для ASP.NET, чтобы сделать это чище или лучше?

+0

заказ NuGet пакет «Microsoft.AspNet.WebApi.HelpPage», чтобы увидеть, если она соответствует вашим потребностям –

ответ

1

Как утверждает Киран. Похоже, страницы справки Web Api должны выполнять эту работу. Возможно, вам придется сначала убедиться в том, что VS.

http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

+0

Я использовал этот пакет несколько раз теперь, и это довольно легко настроить. Он автоматически сканирует ваш проект и создает документацию в комплекте с примером ввода/вывода. – thecodefish