Web API接口开发和测试

4、ASP.NET Web API的开发

 上面我们定义了一般的Web API接口，以及实现相应的业务实现，如果我们需要创建Web API层，还需要构建一个Web API项目的。

 

 

创建好相应的项目后，可以为项目添加一个Web API基类，方便控制共同的接口。

 

然后我们就可以在Controller目录上创建更多的应用API控制器了。

 

最后我们为了统一所有的API接口都是返回JSON方式，我们需要对WebApiConfig里面的代码进行设置下。

public static class WebApiConfig

    {

        public static void Register(HttpConfiguration config)

        {

            // Web API 配置和服务

            config.SetCorsPolicyProviderFactory(new CorsPolicyFactory());

            config.EnableCors();

 

            // Web API 路由

            config.MapHttpAttributeRoutes();

 

            config.Routes.MapHttpRoute(

                name: "DefaultApi",

                routeTemplate: "api/{controller}/{action}/{id}",

                defaults: new { action = "post", id = RouteParameter.Optional }

            );

 

            // Remove the JSON formatter

            //config.Formatters.Remove(config.Formatters.JsonFormatter);

 

            // Remove the XML formatter

            config.Formatters.Remove(config.Formatters.XmlFormatter);

        }

    }

5、Web API 接口的测试

接下来我们要做的就是需要增加业务接口，以便进行具体的测试了，建议使用Winform项目，对每个接口进行一个测试，或者也可以考虑使用单元测试的方式，看个人喜好吧。

例如我们如果要测试用户登陆的接口的话，我们的测试代码如下所示。

/// <summary>

        /// 生成签名字符串

        /// </summary>

        /// <param name="appSecret">接入秘钥</param>

        /// <param name="timestamp">时间戳</param>

        /// <param name="nonce">随机数</param>

        private string SignatureString(string appSecret, string timestamp, string nonce)

        {

            string[] ArrTmp = { appSecret, timestamp, nonce };

 

            Array.Sort(ArrTmp);

            string tmpStr = string.Join("", ArrTmp);

            tmpStr=FormsAuthentication.HashPasswordForStoringInConfigFile(tmpStr, "SHA1");

            return tmpStr.ToLower();

        }

 

        private TokenResult GetTokenResult()

        {

            string timestamp = DateTime.Now.DateTimeToInt().ToString();

            string nonce = new Random().NextDouble().ToString();

            string signature = SignatureString(appSecret, timestamp, nonce);

 

            string appended = string.Format("&signature={0}×tamp={1}&nonce={2}&appid={3}", signature, timestamp, nonce, appId);

            string queryUrl = url + "Auth/GetAccessToken?username=test&password=123456" + appended;

 

            HttpHelper helper = new HttpHelper();

            string token = helper.GetHtml(queryUrl);

            Console.WriteLine(token);

            TokenResult tokenResult = JsonConvert.DeserializeObject<TokenResult>(token);

            return tokenResult;

        }

 

如果我们已经获得了令牌，我们根据令牌传递参数给连接，并获取其他数据的测试处理代码如下所示。

 

//获取访问令牌

            TokenResult tokenResult = GetTokenResult();

 

            string queryUrl = url + "/Contact/get?token=" + tokenResult.access_token;

            HttpHelper helper = new HttpHelper();

            string result = helper.GetHtml(queryUrl);

            Console.WriteLine(result);

 

如果需要POST数据的话，那么调用代码如下所示。

//使用POST方式

            var data = new

            {

                name = "张三",

                certno = "123456789",

            };

            var postData = data.ToJson();

 

            queryUrl = url + "/Contact/Add?token=" + tokenResult.access_token;

            helper = new HttpHelper();

            helper.ContentType = "application/json";

            result = helper.GetHtml(queryUrl, postData, true);

            Console.WriteLine(result);

 

Web API后台，会自动把POST的JSON数据转换为对应的对象的。

 

如果是GET方式，我们可能可以直接通过浏览器进行调试，如果是POST方式，我们需要使用一些协助工具，如Fiddler等处理工具，但是最好的方式是自己根据需要弄一个测试工具，方便测试。

以下就是我为了自己Web API 接口开发的需要，专门弄的一个调试工具，可以自动组装相关的参数，包括使用安全签名的参数，还可以把所有参数数据进行存储。

 

博客 https://www.cnblogs.com/yelanggu/p/10002346.html