使用[FromQuery]时如何记录Swagger / Swashbuckle参数描述

时间:2019-05-16 02:30:26

标签: c# .net-core swagger swashbuckle

我的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 UI时,它没有显示对SomeDataRequest属性的任何描述。

我已经按照This answer的建议将描述放在Description属性和XML注释中。似乎没有任何作用。

我想念一些简单的东西吗?

P.S。在不使用FromQuery的情况下,它似乎确实可以工作。

P.P.S。已解决...问题是SomeDataRequest类在另一个项目中,因此Swashbuckle并未处理其XML文档文件。

0 个答案:

没有答案