如何测试Web API JSON响应?

时间:2014-02-04 10:38:03

标签: c# unit-testing asp.net-web-api xunit xunit.net

我正在尝试为我的网络API设置单元测试。我已经在网上找到了一些我在网上找到的零碎的测试代码。我发送测试请求并收到响应,但我仍然坚持测试响应。

所以这就是我到目前为止所拥有的。这是使用xunit测试包,但我不认为这对我想要实现的目标很重要。

(代码混搭道歉)

[Fact]
public void CreateOrderTest()
{
    string baseAddress = "http://dummyname/";

    // Server
    HttpConfiguration config = new HttpConfiguration();
    config.Routes.MapHttpRoute("Default", "api/{controller}/{action}/{id}",
        new { id = RouteParameter.Optional });
    config.IncludeErrorDetailPolicy = IncludeErrorDetailPolicy.Always;

    HttpServer server = new HttpServer(config);

    // Client
    HttpMessageInvoker messageInvoker = new HttpMessageInvoker(new InMemoryHttpContentSerializationHandler(server));

    // Order to be created
    MotorInspectionAPI.Controllers.AccountController.AuthenticateRequest requestOrder = new MotorInspectionAPI.Controllers.AccountController.AuthenticateRequest() { 
        Username = "Test",
        Password = "password"
    };

    HttpRequestMessage request = new HttpRequestMessage();
    request.Content = new ObjectContent<MotorInspectionAPI.Controllers.AccountController.AuthenticateRequest>(requestOrder, new JsonMediaTypeFormatter());
    request.RequestUri = new Uri(baseAddress + "api/Account/Authenticate");
    request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
    request.Method = HttpMethod.Get;

    CancellationTokenSource cts = new CancellationTokenSource();

    using (HttpResponseMessage response = messageInvoker.SendAsync(request, cts.Token).Result)
    {
        Assert.NotNull(response.Content);
        Assert.NotNull(response.Content.Headers.ContentType);

        // How do I test that I received the correct response?

    }

我希望我可以将响应检查为字符串,类似于

response == "{\"Status\":0,\"SessionKey\":"1234",\"UserType\":0,\"Message\":\"Successfully authenticated.\"}"

2 个答案:

答案 0 :(得分:16)

以下是如何将您的回复作为字符串:

var responseString = response.Content.ReadAsStringAsync().Result;

然而json格式可能会有所不同,我敢打赌你不想测试 - 所以我建议使用Newtonsoft.Json或类似的库,将字符串解析为json对象并测试json对象属性。那就行了

using Newtonsoft.Json.Linq;   

dynamic jsonObject = JObject.Parse(responseString);
int status = (int)jsonObject.Status;
Assert.Equal(0, status);

答案 1 :(得分:1)

根据this blog,在Web项目的AssemblyInfo.cs中添加一个程序集引用:

[assembly: InternalsVisibleTo("MyNamespace.Tests")]

然后,您可以像对普通对象一样进行测试,除非您不能将“var”替换为“动态”类型:

namespace MyNamespace.Tests
// some code
       private string TheJsonMessage()
       {
           dynamic data = _json.Data;
           return data.message;
       }

我花了四个小时才找到那个小宝石。