ASP.NET Web Api 2文档拆分?

时间:2014-02-17 21:20:08

标签: asp.net-web-api2 asp.net-web-api-helppages

在一个大型系统中,有大量资源的api,我希望以某种配置方式分割文档。

就像他们是不同的apis一样。

因此,在web api的主页面中,我有一个已配置的“资源”列表。

让我们说: 管理联系人[这里我想公开'联系'资源,'地址'资源等。 管理订单[产品资源,订单资源,交付资源,平衡资源等] 管理产品[产品资源,类别资源等]

因此api消费者更容易根据任务来理解应该采用哪些方法。

另外,正如您所看到的,不同的部分使用相同的资源,这意味着如果我在Product资源上更改了某些内容,那么两个文档都应该(理想情况下)自动更新,包括版本信息等。

修改

    public ActionResult Index()
    {
        ViewBag.DocumentationProvider = Configuration.Services.GetDocumentationProvider();
        return View(Configuration.Services.GetApiExplorer().ApiDescriptions);
    }

这是我对helpcontroller的索引操作,不确定你的意思。

1 个答案:

答案 0 :(得分:1)

你看过HelpController下的Areas\HelpPage\Controllers了吗?如果您注意到此控制器的Index操作显示有关所有控制器的信息。 如果您的每个资源都由控制器表示,那么您应该能够过滤ApiDescription以仅显示您喜欢的资源。