Swashbuckle:包含swagger文件的“定义”部分的类型

时间:2017-12-15 13:28:16

标签: asp.net swagger swashbuckle

我的应用程序中有一个webapi,可以返回一些数据。数据由“CurrentTask”类型描述,其具有属性“Payload”。

我的应用程序中有一种类型的任务,并且根据类型有效负载prop可以有不同的形状,所以在我的合同中它有类型“object”。除此之外,我还为每种类型的有效负载和后端代码提供了类,这些类主要使用这些类,而不是使用对象。

我认为将这种体验扩展到前端部分也会很棒。所以我想知道是否有办法(例如将属性应用于有效载荷类)告诉Swashbuckle将这些有效载荷类型包含在swagger文件中的“定义”部分。

感谢您的帮助!

代码摘要以便更好地理解:

class TaskController : Controller
{
    [HttpGet]
    public Task<CurrentTask> Next()
    {

    }
}

class CurrentTask
{
    public string Id { get; set; }

    public string Type { get; set; }

    public object Payload { get; set; }
}

class Task1Payload
{
    public string Text { get; set; }
}

class Task2Payload
{
    public string PictureUrl { get; set; }
}

0 个答案:

没有答案