Документация сообщений Message Bus с использованием Swashbuckle.AspNetCore?

Question

Я пытаюсь использовать пакет NuGet Swashbuckle.AspNetCore v4.0.1 в моем проекте ASP.Net Core для создания конечной точки документации SwaggerUI для моего веб-API, который будет использоваться различными командами, работающими в моей компании. Мой API использует и отправляет несколько событий и команд шины сообщений, которые я хотел бы включить в эту документацию.

Существуют ли какие-либо пользовательские настройки в промежуточном программном обеспечении Swashbuckle, которые позволили бы мне документировать объекты ввода / вывода, не связанные с конечными точками API?

Answer 1

То, что конечная точка генерирует событие служебной шины, является внутренней деталью реализации и не требует документирования.

Если вы хотите предоставить документацию для конечной точки, вы можете написать XML-документацию и настроить Swashbuckle для предоставления этой документации с помощью IncludeXmlComments метод.

Microsoft объясняет, как настроить Swagger таким образом, в статье Начало работы с Swashbuckle и ASP.NET Core.