【问题标题】:ASP.NET Web Api 2 Documentation splitting?ASP.NET Web Api 2 文档拆分?
【发布时间】:2014-02-18 22:21:19
【问题描述】:

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

就像它们是不同的 api。

所以在 web api 的主页中,我有一个配置的“资源”列表。

假设: 管理联系人[这里我想公开“联系人”资源、“地址”资源等。 管理订单【产品资源、订单资源、发货资源、余额资源等】 管理产品[产品资源、类别资源等]

因此,api使用者更容易根据任务来理解应该处理哪些方法。

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

编辑:

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

这是我在 helpcontroller 上的索引操作,不知道你的意思。

【问题讨论】:

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


    【解决方案1】:

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

    【讨论】:

    • 不确定你的意思,我用我的索引操作编辑了这个问题。
    • 如您所见,此索引操作返回您案例中所有控制器或资源的所有 ApiDescription。您可以过滤这些描述以仅显示您想要显示的控制器。
    猜你喜欢
    • 2021-12-15
    • 2017-12-09
    • 2014-05-15
    • 1970-01-01
    • 1970-01-01
    • 2015-11-02
    • 1970-01-01
    • 1970-01-01
    • 2013-10-10
    相关资源
    最近更新 更多