Adding the Test API in The ASP.NET Web API Help Page

Introduction

In this article, we will define how to add the Test Client to the ASP. NET Web API help page.

Step 1

First we create the help page. For creating the help page use this link: Creating the Help Page in ASP. NET Web API.

Step 2

Install the test client package using the following procedure:

  • Go to Tools.
  • choose "Library Package Manager" -> "Manage Nuget Packages" for the solution.
  • It is opened like this:

    api1.jpg

  • Make sure to "Include Prerelease".
  • Type "webapitestclient" in the search TextBox in the top-right corner.

    api3.jpg

  • Now click on install for installing it.

    api2.jpg

When the Web API Test Client is installed, the following files will be added to your application:

  • Scripts\WebApiTestClient.js
  • Areas\HelpPage\TestClient.css
  • Areas\HelpPage\views\Help\Display Template\TestClientReferences.cshtml
  • Areas\HelpPage\views\Help\Display Template\TestClientDialogs.cshtml

Step 3

Now write the Test Client on the help page.

For selecting the Api.cshtml, go to the Solution Explorer and choose "Areas\HelpPage\Views\Help\Display Templates\Api.cshtml".

api10.jpg

We add the following code in the Api.cshtml file that is @Html.DisplayForModel("TestClientDialogs"). We can add this code after the <div> tag. And @HtmlDisplayForModel("TestClientReferences") we can add this code inside the scripts section.

  1. @using System.Web.Http  
  2. @using MvcApplication4.Areas.HelpPage.Models  
  3. @model HelpPageApiModel  
  4. @{  
  5.     var description = Model.ApiDescription;  
  6.     ViewBag.Title = description.HttpMethod.Method + " " + description.RelativePath;  
  7. }  
  8. <div id="body">  
  9.     <section class="featured">  
  10.         <div class="content-wrapper">  
  11.             <p>  
  12.                 @Html.ActionLink("Help Page Home""Index")  
  13.             </p>  
  14.         </div>  
  15.     </section>  
  16.     <section class="content-wrapper main-content clear-fix">  
  17.         @Html.DisplayFor(m => Model)  
  18.     </section>  
  19. </div>  
  20. @Html.DisplayForModel("TestClientDialogs")  
  21. @section Scripts {  
  22.     <link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />  
  23.     @Html.DisplayForModel("TestClientReferences")  
  24. } 

Step 4

Now we add some JavaScript files into the TestClientReferences.cshtml that is visible in the scripts folder.

  • jquery-1.8.2.js
  • knockoutjs 2.1.0.js
  • jquery.ui.1.10.3.js

We can drag and drop these files into the TestClientreferences.cshtml file. For selecting the TestClientReferences.cshtml. Go to Solution Explorer and choose
"Areas\HelpPage\Views\Help\Display Templates\TestClientReferences.cshtml".

api9.jpg

The code looks like this:

  1. @using System.Text.RegularExpressions  
  2. <script src="~/Scripts/jquery-1.8.2.js"></script>  
  3. <script src="~/Scripts/knockoutjs%202.1.0.js"></script>  
  4. <script src="~/Scripts/jquery-ui-1.10.3.js"></script>  
  5. <link href="~/Content/themes/base/jquery.ui.all.css" rel="stylesheet" />  
  6. <link href="~/Areas/HelpPage/TestClient.css" rel="stylesheet" />  
  7. @* Automatically grabs the installed version of JQuery/JQueryUI/KnockoutJS *@  
  8. @{var filePattern = @"(jquery-[0-9]+.[0-9]+.[0-9]+.js|jquery-ui-[0-9]+.[0-9]+.[0-9]+.js|knockout-[0-9]+.[0-9]+.[0-9]+.js)";}  
  9. @foreach (var item in Directory.GetFiles(Server.MapPath(@"~/Scripts")).Where(f => Regex.IsMatch(f, filePattern)))  
  10. {  
  11.     <script src="~/Scripts/@Path.GetFileName(item)"></script>  
  12. }  
  13. <script src="~/Scripts/WebApiTestClient.js" defer="defer"></script> 

If these files are not showing in Scripts folder then you can download these files.

Step 5

After performing these steps, when we execute the application the Test API button is shown in lower-right corner. And the output looks like this:

api4.jpg

Step 6

Now we test the Web API.

  • We click on Test API button. There is the URI parameter open and one TextBox for the URI parameter.
  • And fill the value in the TextBox. Click on "Add header" and enter "application/json". That gives the response in JSON.

    api5.jpg

  • Now click on the "Send" button.
  • It give the response.

    api6.jpg

Step 7

Add the request header.

api7.jpg

Click on "Add header" and add the "accept text/xml" asking for XML. Click on the "Send" button.

The response is:

api8.jpg