c# - 单独项目下的 ASP.NET Web API 帮助页面

Question

我有 ASP.NET Web API 项目，我想添加一个帮助页面，但我希望它位于一个单独的项目中。

这可能吗？

Answer 1

您可以将 XmlDocumentationProvider 构造函数重写为类似这样的内容:

public XmlDocumentationProvider(string appDataPath)
{
    if (appDataPath == null)
    {
        throw new ArgumentNullException(nameof(appDataPath));
    }

    var files = new[] { "MyWebApiProject.xml" /*, ... any other projects */ };
    foreach (var file in files)
    {
        var xpath = new XPathDocument(Path.Combine(appDataPath, file));
        _documentNavigators.Add(xpath.CreateNavigator());
    }
}

它将包括您在数组中列出的所有 xml 文档文件。您还应该确保您的目标 Web API 项目(以及所有模型项目，如果需要)在生成时生成文档并将其复制到正确的位置。