给写ajax接口一个通用测试顶目

使用技术:mvc,jquery,json2,反射.

先上效果图

关键代码

 

  //下面三行代码为核心代码,
                //使用反射,输入类路经得到类的类型
                Type type = Type.GetType(inputClassName);
                //得到输入类的实例,并赋值
                object t = CommentAjaxInterfaceText.comment.CommentClass.Deserialize(type, inputString);
                //使用反射,动态调用所需要的接口,并把输入值对象传递给方法
                return this.GetType().GetMethod(interfaceName).Invoke(this, new object[] { t }) as ActionResult;

 

 

 

 

配置文件   /config/methodsStructure.txt  的内容

 

login###
登陆消息###
true###
InLogin###
{"email":"[e-mail]","password":"fdsafdsafdsa"}###
{"nickname":"tom","userid":"xxx","sessioncode":"xxxxx","header":"xxxxxx"}#$#

以###为分割符,以#$#为结果符,所代表的意思如下

第一个:接口名称 ,如:login.

第二个:接口描述,如登陆消息.

第三个:表示此接口是否启用,布尔类型(true,false)

第三个:接口输入值,MVC可以自动配置输入的键值对,所以我们以类形式做为输入参数

第四个:接口输出值的参考.

通用测试实现代码

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using CommentAjaxInterfaceText.comment;
using CommentAjaxInterfaceText.ModelInput;

namespace CommentAjaxInterfaceText.Controllers
{
    public class InterfaceController : Controller
    {

        #region 测试界面
        /// <summary>
        /// 用来存放模板里接口基本信息,如果有新的接口添加,只需要在  /config/methodsStructure.txt  添加接口的基本信息,就可以进行接口测试了.
        /// </summary>
        private static List<InputTemple> config = new List<InputTemple>();

        /// <summary>
        /// 提取配置文件信息,并显现在界面上,如方法名列表,
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult Test()
        {
            //读取配置文件
            string strconfig = CommentAjaxInterfaceText.comment.CommentClass.ReadFile("/config/methodsStructure.txt");
            string[] str = strconfig.Split(new string[] { "#$#", "###" }, StringSplitOptions.RemoveEmptyEntries);
            config = new List<InputTemple>();
            for (int i = 0; i < str.Length / 6; i++)
            {
                InputTemple inputTemple = new InputTemple();
                inputTemple.methods = str[0 + 6 * i].Trim('\r').Trim('\n');
                inputTemple.description = str[1 + 6 * i].Trim('\r').Trim('\n');
                inputTemple.enabled = Convert.ToBoolean(str[2 + 6 * i].Trim('\r').Trim('\n'));
                inputTemple.inputClass = str[3 + 6 * i].Trim('\r').Trim('\n');
                inputTemple.input = str[4 + 6 * i].Trim('\r').Trim('\n');
                inputTemple.output = str[5 + 6 * i].Trim('\r').Trim('\n');
                config.Add(inputTemple);
            }
            return View(config);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="interfaceName">接口名</param>
        /// <param name="inputClass">输入参数类型</param>
        /// <param name="inputString">输入值,JSON形式</param>
        /// <returns></returns>
        [HttpPost]        
        public ActionResult TestMomber(string interfaceName, string inputClass, string inputString)
        {
            try
            {
                if (String.IsNullOrEmpty(interfaceName))
                    return Json("函数名不能为空", JsonRequestBehavior.AllowGet);
                if (String.IsNullOrEmpty(inputString))
                    return Json("输入值不能为空", JsonRequestBehavior.AllowGet);
                string inputClassName = "CommentAjaxInterfaceText.ModelInput." + inputClass;   
                //下面三行代码为核心代码,
                //使用反射,输入类路经得到类的类型
                Type type = Type.GetType(inputClassName);
                //得到输入类的实例,并赋值
                object t = CommentAjaxInterfaceText.comment.CommentClass.Deserialize(type, inputString);
                //使用反射,动态调用所需要的接口,并把输入值对象传递给方法
                return this.GetType().GetMethod(interfaceName).Invoke(this, new object[] { t }) as ActionResult;
            }
            catch (Exception ex)
            {
                return Json(ex.Message, JsonRequestBehavior.AllowGet);
            }
        }

        [HttpPost]
        public ActionResult GetFunData(string methods)
        {
            InputTemple temple = config.Find(P => P.methods == methods);
            return Json(temple, JsonRequestBehavior.AllowGet);
        }

        #endregion

        #region    一个登录测试接口
        /// <summary>
        /// 
        /// </summary>
        /// <param name="intput">输入参数,以类形式传入到接口</param>
        /// <returns></returns>
        public ActionResult login(InLogin intput)
        {
            try
            {
                OutLogin output = new OutLogin();
                output.header = "XXXX";
                output.nickname = "XX";
                output.sessioncode = "0000";
                output.userid = 25;
                return Json(output, JsonRequestBehavior.AllowGet);
                
            }
            catch (Exception ex)
            {
                return Content(ex.Message);
            }

        }

        #endregion

    } 
}

 

通用方法

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.IO;
using System.Text;

namespace CommentAjaxInterfaceText.comment
{
    public class CommentClass
    {
        #region 读取文件内容
        /// <summary>
        /// 读取文件内容
        /// </summary>
        /// <param name="file">格式:a/b.htm,相对根目录</param>
        /// <returns></returns>
        public static string ReadFile(string file)
        {
            try
            {
                System.IO.StreamReader sr = new System.IO.StreamReader(System.Web.HttpContext.Current.Server.MapPath(file), System.Text.Encoding.GetEncoding("GB2312"));// System.Text.Encoding.UTF8
                string str = sr.ReadToEnd();
                sr.Close();
                return str;
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }
        #endregion

        /// <summary>
        /// json传转成对象
        /// </summary>
        /// <param name="type"></param>
        /// <param name="json"></param>
        /// <returns></returns>
        public static object Deserialize(Type type, string json)
        {
            using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(json)))
            {
                System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(type);
                return serializer.ReadObject(ms);
            }
        }
    }
}

 

界面

@model List<CommentAjaxInterfaceText.comment.InputTemple>
<html>
<head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
    <title>接口测试界面</title>
    <style type="text/css">
        /* reset */
        *, body
        {
            margin: 0;
            padding: 0;
        }
        /* commons */
        body
        {
            font-size: 13px;
        }
        .clearfix
        {
            zoom: 1;
        }
        .clearfix:after
        {
            content: ´.´;
            display: block;
            visibility: none;
            height: 0;
            clear: both;
        }
        #bd
        {
            min-height: 50px;
            _height: 50px;
        }
        #bd .right
        {
            float: right;
            width: 100%;
            margin-left: -25em;
        }
        #bd .right .content
        {
            margin-left: 270px;
        }
        #bd .left
        {
            width: 260px;
            float: left;
        }
        p
        {
            border-width: 1px;
            border-style: solid;
        }
    </style>
    <script src="http://www.cnblogs.com/Scripts/jquery.1.7.2.min.js" type="text/javascript"></script>
    <script src="http://www.cnblogs.com/Scripts/json2.js" type="text/javascript"></script>
    <script type="text/javascript">
        $(document).ready(function () {
            $(".left p").each(function (i) {
                $(this).bind("click", function (obj) {
                    var methods = $(this).find("span:eq(1)").text()
                    var desc = "   描述：" + $(this).find("span:eq(0)").text()
                    $("#key").val(methods);
                    $("#dest").text(desc);
                    $("#key").attr("inputClass", $(this).attr("inputClass"));
                    $("#input").val("");
                    $("#output").val("");
                    $("#result").val("");
                    var address = window.location.href.replace("test", methods);
                    //address = window.location.href.replace("Test", methods);
                    $("#address").val(address);
                    GetFunData(methods);
                });
            });
        });



        //提交测试
        function submitTest() {
            var interfaceName = $("#key").val();
            var input = $("#input").val();
            var inputClass = $("#key").attr("inputClass"); 
            $.ajax({
                type: "POST",
                async: false,
                url: "/Interface/TestMomber",
                data: { "interfaceName": interfaceName, "inputClass": inputClass, "inputString": input},              
                success: function (msg) {
                    var jsonstring = JSON.stringify(msg);
                    $("#result").val(jsonstring);
                }
            });
        };

        //函数名得到输入输出值

        function GetFunData(methods) {
            $.ajax({
                type: "POST",
                async: false,
                url: "/Interface/GetFunData",
                data: { "methods": methods },
                //data: { "email": interfaceName, "password": input },
                success: function (msg) {
                    $("#input").val(msg.input);
                    $("#output").val(msg.output);
                }
            });
        }


    
    </script>
</head>
<body>
    <h1 style="text-align: center">
        接口测试界面</h1>
    <div id="hd" style="color: Red">
        注:如果没有输入参数或示例,请刷新下页面重试</br>(红色字体表示没实现此接口)
    </div>
    <div id="bd" class="clearfix">
        <div class="right">
            <div class="content">
                接 口:<input id="key" type="text" /><label id="dest"></label></br> 地 址:<input id="address"
                    type="text" style="width: 350px" /></br><span style="vertical-align: top">输 入:</span><textarea
                        id="input" rows="4" style="width: 1000px;"></textarea></br> <span style="vertical-align: top">
                            输 出:</span><textarea rows="11" id="result" style="width: 1000px;"></textarea></br>
                <span style="vertical-align: top">示 例:</span><textarea id="output" rows="8" style="width: 1000px;"
                    readonly="readonly"></textarea></br>
                <input type="button" onclick="submitTest()" value="提交" />
                <a target="_blank" href="http://jsonlint.com/">JSON 格式验证地址</a>
            </div>
        </div>
        <div class="left">
            函数列表:
            @{
                foreach (CommentAjaxInterfaceText.comment.InputTemple item in Model)
                {
                    if (item.enabled)
                    {
                <p inputClass="@item.inputClass">
                    <span>@item.description </span><span>@item.methods</span></p> 
                    }
                    else
                    {
                <p inputClass="@item.inputClass">
                    <span style="color: Red">@item.description </span><span>@item.methods</span></p> 
                    }
                }
            }
        </div>
    </div>
    <div id="ft">
    </div>
</body>
</html>

源码下载