Improvements to the Testclient

example/apidoc.json

@@ -17,4 +17,8 @@
   	"withCompare": true,
   	"withGenerator": true
   }
+  "jQueryAjaxSetup": {
+	"headers": {
+		"X-Your-CustomHeader": "some value",
+	}
 }

lib/package_info.js

@@ -161,6 +161,11 @@ PackageInfo.prototype._extractApiDocJsonData = function(json)
 		};
 		app.debug("read footer file: " + filename);
 	}
+
+	// Custom jQueryAjaxSetup
+	if (json.jQueryAjaxSetup) {
+		packageInfo.jQueryAjaxSetup = json.jQueryAjaxSetup;
+	}
 
 	return packageInfo;
 }; // _extractApiDocJsonData

template/main.js

@@ -47,8 +47,8 @@ require([
 	/**
 	 * Load google web fonts.
 	 */
-  loadGoogleFontCss($);
-
+	loadGoogleFontCss($);
+	
 	var api = apiData.api;
 
 	/**
@@ -70,6 +70,11 @@ require([
 	if(apiProject.template.withCompare == null) apiProject.template.withCompare = true;
 	if(apiProject.template.withGenerator == null) apiProject.template.withGenerator = true;
 
+    /**
+	 * Setup jQuery Ajax
+	 */
+	$.ajaxSetup(apiProject.jQueryAjaxSetup); 
+
 	/**
 	 * Data transform.
 	 */

template/utils/send_sample_request.js

@@ -30,6 +30,9 @@ define([
   {
       var $root = $('article[data-group="' + group + '"][data-name="' + name + '"][data-version="' + version + '"]');
 
+	  // Fade out the previous response to make clear that there is a new response somewhen...
+	  $root.find(".sample-request-response").fadeTo(1, 0.1);
+
       // create JSON dictionary of parameters
       var dict = {};
       $root.find(".sample-request-param").each(function(i, element) {
@@ -54,25 +57,42 @@ define([
           }
       } // while     
 
+	  var jsonData = JSON.stringify(dict);
+
       // send AJAX request, catch success or error callback
       $.ajax({
           url: url,
           dataType: "json",
-          data: dict,
+		  contentType: "application/json",
+          data: jsonData,
           type: type.toUpperCase(),
           success: displaySuccess,
           error: displayError
       });
 
       function displaySuccess(data) {
-          $root.find(".sample-request-response").show();
+          var message = JSON.stringify(data, null, 4);
+
           $root.find(".sample-request-response-json").html(JSON.stringify(data, null, 4));
+		  $root.find(".sample-request-response").fadeTo(250, 1);
+
           refreshScrollSpy();
       };
 
       function displayError(jqXHR, textStatus, error) {
-          $root.find(".sample-request-response").show();
-          $root.find(".sample-request-response-json").html(jqXHR.status + " Error: " + error);
+          var message = "Error " + jqXHR.status + ": " + error;
+		  var jsonResponse = JSON.parse(jqXHR.responseText);
+
+		  if (jsonResponse) {
+		      message += "<br /><br />" + JSON.stringify(jsonResponse, null, 4)
+		  }
+		  else {
+		      message += "<br /><br />" + jqXHR.responseText;
+		  }
+
+		  $root.find(".sample-request-response-json").html(message);
+		  $root.find(".sample-request-response").fadeTo(250, 1);
+
           refreshScrollSpy();
       };
   }