Страница справки Web Api XML-комментарии более чем из 1 файла

Ответ 1

Вы можете изменить установленный XmlDocumentationProvider на Areas\HelpPage, чтобы сделать что-то вроде следующего:

Объединить несколько файлов документов Xml в один файл:

Пример кода (отсутствует проверка и проверка ошибок):

using System.Xml.Linq;
using System.Xml.XPath;

 XDocument finalDoc = null;
 foreach (string file in Directory.GetFiles(@"PluginsFolder", "*.xml"))
 {
    if(finalDoc == null)
    {
        finalDoc = XDocument.Load(File.OpenRead(file));
    }
    else
    {
        XDocument xdocAdditional = XDocument.Load(File.OpenRead(file));

        finalDoc.Root.XPathSelectElement("/doc/members")
                     .Add(xdocAdditional.Root.XPathSelectElement("/doc/members").Elements());
    }
}

// Supply the navigator that rest of the XmlDocumentationProvider code looks for
_documentNavigator = finalDoc.CreateNavigator();

Ответ 2

Решение Киранса работает очень хорошо. Я закончил использовать его подход, но создав копию XmlDocumentationProvider, называемую MultiXmlDocumentationProvider, с измененным конструктором:

public MultiXmlDocumentationProvider(string xmlDocFilesPath)
{
       XDocument finalDoc = null;
        foreach (string file in Directory.GetFiles(xmlDocFilesPath, "*.xml"))
        {
            using (var fileStream = File.OpenRead(file))
            {
                if (finalDoc == null)
                {
                    finalDoc = XDocument.Load(fileStream);
                }
                else
                {
                    XDocument xdocAdditional = XDocument.Load(fileStream);

                    finalDoc.Root.XPathSelectElement("/doc/members")
                        .Add(xdocAdditional.Root.XPathSelectElement("/doc/members").Elements());
                }
            }
        }

        // Supply the navigator that rest of the XmlDocumentationProvider code looks for
        _documentNavigator = finalDoc.CreateNavigator();
}

Я зарегистрирую нового провайдера из HelpPageConfig.cs:

config.SetDocumentationProvider(new MultiXmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/")));

Создание нового класса и сохранение исходного без изменений может быть более удобным при обновлении и т.д.

Ответ 3

Вместо того, чтобы создавать отдельный класс по строкам XmlMultiDocumentationProvider, я просто добавил конструктор к существующему XmlDocumentationProvider. Вместо того, чтобы брать имя папки, это берет список строк, поэтому вы можете точно указать, какие файлы вы хотите включить (если в каталоге, в котором находится XML-документ, есть другие файлы xml, это может стать волосатым). Здесь мой новый конструктор:

public XmlDocumentationProvider(IEnumerable<string> documentPaths)
{
    if (documentPaths.IsNullOrEmpty())
    {
        throw new ArgumentNullException(nameof(documentPaths));
    }
    XDocument fullDocument = null;
    foreach (var documentPath in documentPaths)
    {
        if (documentPath == null)
        {
            throw new ArgumentNullException(nameof(documentPath));
        }

        if (fullDocument == null)
        {
            using (var stream = File.OpenRead(documentPath))
            {
                fullDocument = XDocument.Load(stream);
            }
        }
        else
        {
            using (var stream = File.OpenRead(documentPath))
            {
                var additionalDocument = XDocument.Load(stream);
                fullDocument?.Root?.XPathSelectElement("/doc/members").Add(additionalDocument?.Root?.XPathSelectElement("/doc/members").Elements());
            }
        }
    }

    _documentNavigator = fullDocument?.CreateNavigator();
}

HelpPageConfig.cs выглядит так. (Да, это может быть меньше строк, но у меня нет предела линии, поэтому мне нравится разбивать его.)

var xmlPaths = new[]
{
    HttpContext.Current.Server.MapPath("~/bin/Path.To.FirstNamespace.XML"),
    HttpContext.Current.Server.MapPath("~/bin/Path.To.OtherNamespace.XML")
};
var documentationProvider = new XmlDocumentationProvider(xmlPaths);
config.SetDocumentationProvider(documentationProvider);

Ответ 4

Я согласен с gurra777 в том, что создание нового класса - более безопасный путь обновления. Я начал с этого решения, но он включает в себя большое количество копий/макаронных изделий, которые могут легко устаревать после нескольких обновлений пакета.

Вместо этого я сохраняю коллекцию детей XmlDocumentationProvider. Для каждого из методов реализации я вызываю детей, чтобы получить первый непустой результат.

public class MultiXmlDocumentationProvider : IDocumentationProvider, IModelDocumentationProvider
{
    private IList<XmlDocumentationProvider> _documentationProviders;

    public MultiXmlDocumentationProvider(string xmlDocFilesPath)
    {
        _documentationProviders = new List<XmlDocumentationProvider>();

        foreach (string file in Directory.GetFiles(xmlDocFilesPath, "*.xml"))
        {
            _documentationProviders.Add(new XmlDocumentationProvider(file));
        }
    }

    public string GetDocumentation(System.Reflection.MemberInfo member)
    {
        return _documentationProviders
            .Select(x => x.GetDocumentation(member))
            .FirstOrDefault(x => !string.IsNullOrWhiteSpace(x));
    }

    //and so on...

Регистрация HelpPageConfig такая же, как в ответе gurra777,

config.SetDocumentationProvider(new MultiXmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/")));