定义数据接口返回数据格式

迷南。 2021-06-24 16:11 479阅读 0赞

为了规范数据返回格式，现在将结果约定为返回以下三个字段：  
Code,Msg,Data

1.  定义result类：

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    
    namespace MyBlogNew.Common
    {
        public class Result<T>
        {
            public int Code {get;set; }
    
            public string Msg { get; set; }
    
            public T Data { get; set; }
        }
    }

1.  编写接口测试：

public Result<int> GetDiariesTotalNumOne()
            {
                Result<int> result = new Result<int>();
                try
                {
                    using (var entity = new MyBlogNewEntities())
                    {
                        int totalPage = entity.Diaries.ToList().Count();
                        result.Code = 1;
                        result.Msg = "success";
                        result.Data = totalPage;
                        return result;
                    }
                }
                catch (Exception ex)
                {
                    throw (ex);
                }
            }
    
            public Result<List<string>> GetDiariesTotalNumTwo()
            {
                Result<List<string>> result = new Result<List<string>>();
                try
                {
                    using (var entity = new MyBlogNewEntities())
                    {
                        int totalPage = entity.Diaries.ToList().Count();
                        result.Code = 1;
                        result.Msg = "success";
                        result.Data = new List<string> {"hello","world" } ;
                        return result;
                    }
                }
                catch (Exception ex)
                {
                    throw (ex);
                }
            }
    public Result<Dictionary<int,string>> GetDiariesTotalNumTwo()
            {
                Result<Dictionary<int, string>> result = new Result<Dictionary<int, string>>();
                try
                {
                    using (var entity = new MyBlogNewEntities())
                    {
                        int totalPage = entity.Diaries.ToList().Count();
                        result.Code = 1;
                        result.Msg = "success";
                        
                        Dictionary<int,string> map = new Dictionary<int, string>();
                        map.Add(1,"hello");
                        map.Add(2,"world");
                        result.Data = map;
                        return result;
                    }
                }
                catch (Exception ex)
                {
                    throw (ex);
                }
            }

1.  测试结果
    
      
    
    
    ![2789632-19f51878a7741b8a.png][]
    
      
    
    
    ![2789632-d33d733b9dee75be.png][]
    
      
    
    
    ![2789632-a087410b933c4ba7.png][]

![2789632-3b18269684ea9294.png][]

公众号.png

[2789632-19f51878a7741b8a.png]: /images/20210615/234eb65f7b564bdfac898fd4859a15c6.png
[2789632-d33d733b9dee75be.png]: /images/20210615/ccb50dd5cea14ac49949a1383b2866f2.png
[2789632-a087410b933c4ba7.png]: /images/20210615/585e50a24f584f27aa828d276dbd767b.png
[2789632-3b18269684ea9294.png]: /images/20210615/d6a0a571e3cb4e828b2a44b706e84628.png