Swagger-Swashbuckle включает xmlcomments из зависимых библиотек

Question

Мне нужно документировать основные веб-интерфейсы asp.net, и я использую swagger и swashbuckle.

Я осмотрелся и нашел эту ссылку, но она старая и не работает https://github.com/domaindrivendev/Swashbuckle/issues/93

Может кто-нибудь показать / указать мне, как я могу включить комментарии XML от другой DLL?

спасибо

Answer 1

Существует две версии автомата:

• https://github.com/domaindrivendev/Swashbuckle
• https://github.com/domaindrivendev/Swashbuckle.AspNetCore

Если теги по этому вопросу верны, ваша ссылка не на версию, которую вы используете, но все же предлагаемое решение должно дать вам хорошее представление о том, что вам нужно сделать.

Вы можете добавить столько xml-комментариев, сколько хотите, с IncludeXmlComments, который все еще доступен в Swashbuckle.AspNetCore, см. Здесь:
Swashbuckle.AspNetCore.SwaggerGen / Application / SwaggerGenOptions.cs # L259

Сначала вам нужно убедиться, что необходимые вам xml-комментарии отправляются на сервер как часть вашего развертывания, иначе Swashbuckle не покажет, чего там нет ...

Решением может быть рекурсивный цикл поиска файлов XML и добавление их с помощью IncludeXmlComments, что-то вроде этого:

public void IncludeAllXmlComments(string folder)
{
  if (!string.IsNullOrEmpty(folder))
  {
    foreach (var name in Directory.GetFiles(folder, "*.XML", SearchOption.AllDirectories))
    {
      IncludeXmlComments(filePath: name);
    }
  }
}

Этот пример кода предназначен только для того, чтобы дать вам представление, а не для копирования / пасты