Как задокументировать описания параметров Swagger / Swashbuckle при использовании [FromQuery] - PullRequest
Новая
       14

Как задокументировать описания параметров Swagger / Swashbuckle при использовании [FromQuery]

0 голосов
/ 16 мая 2019

Моя конечная точка API: 

[HttpGet]
public ActionResult GetSomeData([FromQuery] SomeDataRequest request) {
    return File(returnImage(), "image/png");
}

public class SomeDataRequest {
  /// <summary>
  /// Description 1
  /// </summary>
  [Description("description 1")]
  public string foo;

  /// <summary>
  /// Description 2
  /// </summary>
  [Description("description 2")]
  public string bar;
}

Когда я открываю интерфейс Swagger, он не показывает никаких описаний свойств SomeDataRequest.

Я разместил описания в атрибуте Description и в комментариях к XML в соответствии с предложением Этот ответ . Кажется, ничего не работает.

Мне не хватает чего-то простого?

P.S. Кажется, он работает в других сценариях, когда FromQuery не используется.

P.P.S. Решено ... Проблема заключалась в том, что класс SomeDataRequest находился в другом проекте, и поэтому файл XML-документации не обрабатывался Swashbuckle.

...