在 API 的网页中记录 Web API

Question

我有一个 webAPI，其中有很多功能。当用户访问 api 链接时，我想创建一个描述 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 );
    }

然后，当我访问该网站时，我可以访问一个网页，我将在该网页上放置我的内容，当我点击该网页上的 ping 链接（该网页是实时的）时，我会访问 ping 说明。

我觉得应该有更好的方法来做到这一点。有谁知道 ASP.NET 的任何内置功能可以使它更清洁或更好？

Answer 1

正如基兰所说。听起来 Web Api 帮助页面应该可以完成这项工作。您可能需要先确保您的 VS 是最新的。

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