接口 Swagger 顯示返回模型的注釋

mark：環境看之前文章

目的：web api controller 調用 asp.net mvc controller，讓swagger里面的返回模型支持注釋

關鍵：對返回消息類的封裝，返回數據為泛型，swagger就能顯示model的注釋了

JsonMsg

/// <summary>
/// 返回消息
/// </summary>
public class JsonMsg<T> where T : class
{
    /// <summary>
    /// 狀態碼
    /// </summary>
    public int code { get; set; }

    /// <summary>
    /// 消息
    /// </summary>
    public string msg { get; set; }

    /// <summary>
    /// 內容
    /// </summary>
    public T obj { get; set; }

    /// <summary>
    /// 圖標
    /// </summary>
    public int icon { get; set; }


    public static JsonMsg<T> OK(T obj, string msg = "成功") 
    {
        return new JsonMsg<T>() { code = 1, msg = msg, obj = obj, icon = 1 };
    }

    public static JsonMsg<T> Error(T obj, string msg = "失敗")
    {
        return new JsonMsg<T>() { code = 0, msg = msg, obj = obj, icon = 1 };
    }
}

OrderDto

public class OrderDto
{
    public string Name { get; set; }
}

HomeController

public JsonResult GetOrderInfo()
{
    var order = new OrderDto { Name = "203022200" };
    return Json(order);
}

HomeAPIController

[AllowAnonymous]
public JsonMsg<OrderDto> testResultDataDesc3()
{
    HomeController controller = GetController<HomeController>();
    var d = (OrderDto)controller.GetOrderInfo().Data;
    return JsonMsg<OrderDto>.OK(d);
}

效果