本文介绍了如何在Swagger中让返回模型支持注释。关键在于创建一个名为JsonMsg的公共类，作为返回消息的封装，使用泛型并包含状态码、消息、内容和图标属性。通过JsonMsg类的静态方法OK和Error，可以方便地设置返回信息。在示例中，展示了如何在HomeController和HomeAPIController中使用JsonMsg，并在Swagger中正确显示OrderDto模型的注释。
mark：环境看之前文章
目的：web api controller 调用 asp.net mvc controller，让swagger里面的返回模型支持注释
关键：对返回消息类的封装，返回数据为泛型，swagger就能显示model的注释了
JsonMsg
///
/// 返回消息
///
public class JsonMsg where T : class
{
///
/// 状态码
///
public int code { get; set; }
///
/// 消息
///
public string msg { get; set; }
///
/// 内容
///
public T obj { get; set; }
///
/// 图标
///
public int icon { get; set; }
public static JsonMsg OK(T obj, string msg = "成功")
{
return new JsonMsg() { code = 1, msg = msg, obj = obj, icon = 1 };
}
public static JsonMsg Error(T obj, string msg = "失败")
{
return new JsonMsg() { 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 testResultDataDesc3()
{
HomeController controller = GetController();
var d = (OrderDto)controller.GetOrderInfo().Data;
return JsonMsg.OK(d);
}
效果
扫一扫
9316
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
