XML Комментарии плохо форматируются в Swagger UI - PullRequest
0 голосов
/ 26 февраля 2020

Я использую Swashbuckle для настройки Swagger UI, чтобы он отображал мои XML комментарии о моих операциях.

Когда я это делаю, они выглядят очень раздавленными. Вот пример того, как это выглядит без комментариев:

Looks Good But No Comments

Вот как это выглядит с комментариями:

Has Comments But Method Name is Squished

Есть ли какой-нибудь способ получить интерфейс Swagger, чтобы выделить больше места для имени операции?

1 Ответ

1 голос
/ 26 февраля 2020

<summary> должен быть кратким описанием, таким как «Создать foo» или «Вернуть foo по идентификатору». Длинные описания, содержащие подробности использования, должны быть от go до <remarks>. <remarks> соответствует полю OpenAPI description; Swagger UI отображает эти описания в расширенных операциях. Эти описания могут быть отформатированы с использованием Markdown для представления расширенного текста.

/// <summary>
/// Create a foo
/// </summary>
/// <remarks>
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
/// sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
/// Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris
/// nisi ut aliquip ex ea commodo consequat.
/// </remarks>
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...