Файл комментариев Swagger XML - недостающие комментарии - PullRequest
1 голос
/ 29 апреля 2019

Я сам размещаю документацию Swagger для моего API Web API 2 с Swashbuckle.Core 5.6.0

Я включаю Swagger в мои Startup.cs следующим образом

config.EnableSwagger(c => 
        {
            c.SingleApiVersion("v1", "AUDM API");
            c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "commentsfile1.xml");
            c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "commentsfile2.xml");
            c.DescribeAllEnumsAsStrings();
        }).EnableSwaggerUi(/*x => x.DisableValidator()*/);

Пользовательский интерфейс Swagger обнаруживается просто отлично, перечисляя все мои конечные точки и методы.Но документации на ноль нет ... все мои комментарии и замечания в контроллерах отсутствуют, как и

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

Два xml-файла приходят из разных библиотек, но это не должно иметь значения, если это .. файлы есть, так что ИМХО их следует использовать.Есть ли способ выяснить, почему не извлекаются файлы XML?

1 Ответ

0 голосов
/ 29 апреля 2019

Я думаю, что вы можете пропустить косую черту \ в пути, попробуйте это:

c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "\commentsfile1.xml");

вот пример из официального проекта: https://github.com/domaindrivendev/Swashbuckle/blob/5489aca0d2dd7946f5569341f621f581720d4634/Swashbuckle.Dummy.Core/App_Start/SwaggerConfig.cs#L261

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...