如何使Swagger显示从API返回的对象示例？

14 浏览
0 Comments

如何使Swagger显示从API返回的对象示例？

我第一次创建一组API。以下是其中一种方法：

// GET: api/Doors/0

///

/// 获取给定组织的所有门列表。

///

/// 应检索所有门的组织ID。

///

[Route("{organizationSys:int}")]

public IHttpActionResult Get(int organizationSys)

{

try

{

Dictionary parameters = new Dictionary();

parameters.Add("@OrganizationSys", organizationSys);

List doors = Repository.GetList("WHERE OrganizationSys = @OrganizationSys", parameters).ToList();

if (doors == null || doors.Count() == 0)

return Content(HttpStatusCode.NotFound, RejectionMessage.NoItemsFound);

return Ok(doors);

}

catch (Exception ex)

{

return Content(HttpStatusCode.BadRequest, ex.Message);

}

}

我已经为此端点设置了单元测试，并且它运行得非常完美。然而，我有一个问题。

在Swagger中，我想显示将返回的数据对象的示例。由于方法上唯一的返回类型是IHttpActionResult，因此我不奇怪Swagger没有显示数据模型。那么，我需要如何更改此方法以使返回对象（在本例中是List）更加可见？

Swashbuckle是否支持此功能？

谢谢！

0