[经验分享]WebAPI中返回类型JsonMessage的应用

Posted MartyZane

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了[经验分享]WebAPI中返回类型JsonMessage的应用相关的知识,希望对你有一定的参考价值。

这是一个绝无仅有的好类型,一个你爱不释手的好类型,好了,不扯了,直接上干货。

相信大家都知道,在调用接口的时候返回Json数据已经成为一种不成文的标准,因为它的解析快,易读等优秀的特性,所以被绝大多数的程序猿们所喜爱。

今天就给大家介绍一种您可能忽略或者还不知道的返回类型JsonMessage

 1     /// <summary>
 2     /// 返回消息
 3     /// </summary>
 4     public class JsonMessage
 5     {
 6         /// <summary>
 7         /// 是否成功
 8         /// </summary>
 9         public bool Success { get; set; }
10         /// <summary>
11         /// 结果编码
12         /// </summary>
13         public string Code { get; set; }
14         /// <summary>
15         /// 结果消息
16         /// </summary>
17         public string Message { get; set; }
18 
19         public override string ToString()
20         {
21             return JsonHelper.ToJson(this);
22         }
23     }

以上是JsonMessage的全部代码,由此可以看出,大家不必在费心的去考虑我应该用什么参数来设置我的返回信息,这个就已经给大家准备了统一并全面的参数返回值。

直接上Demo

 1         /// <summary>
 2         /// 演示
 3         /// </summary>
 4         /// <returns>Json格式的信息</returns>
 5         [HttpPost]
 6         [Route("Api/Login/Demo")]
 7         public JsonMessage Demo()
 8         {
 9             JsonMessage jmTemp = new JsonMessage();
10             try
11             {
12                 jmTemp.Code = "200";
13                 jmTemp.Message = "演示成功";
14                 jmTemp.Success = true;
15             }catch(Exception ex)
16             {
17                 jmTemp.Code = "201";
18                 jmTemp.Message = "演示失败";
19                 jmTemp.Success = false;
20             }
21             return jmTemp;
22         }

看看展示的效果吧

到此就结束了,是不是很简单

==================================================

打赏他:

   

以上是关于[经验分享]WebAPI中返回类型JsonMessage的应用的主要内容,如果未能解决你的问题,请参考以下文章

Web Api 接口返回值不困惑:返回值类型详解

Web Api 接口返回值不困惑:返回值类型详解

.NET Core 处理 WebAPI JSON 返回烦人的null为空

后端接口迁移(从 webapi 到 openapi)前端经验总结

后端接口迁移(从 webapi 到 openapi)前端经验总结

webapi的返回类型,webapi返回图片