add param File upload support (apidoc#850)

* add param file upload support Co-authored-by: js-obito <[email protected]>
dut3062796s · Apr 25, 2020 · 6811d58 · 6811d58
1 parent addf62a
commit 6811d58
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/example/example.js b/example/example.js
@@ -72,6 +72,7 @@ function postUser() { return; }
  * @apiDescription This function has same errors like POST /user, but errors not defined again, they were included with "apiErrorStructure"
  *
  * @apiParam {String} name Name of the User.
+ * @apiParam {File} avatar Upload avatar.
  *
  * @apiUse CreateUserError
  */

diff --git a/template/index.html b/template/index.html
@@ -291,7 +291,7 @@ <h4><input type="checkbox" data-sample-request-param-group-id="sample-request-pa
               <div class="form-group">
                 <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label>
                 <div class="input-group">
-                  <input id="sample-request-param-field-{{field}}" type="text" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true"{{/if}}>
+                  <input id="sample-request-param-field-{{field}}" type="{{setInputType type}}" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true"{{/if}}>
                   <div class="input-group-addon">{{{type}}}</div>
                 </div>
               </div>

diff --git a/template/utils/handlebars_helper.js b/template/utils/handlebars_helper.js
@@ -21,6 +21,16 @@ define([
         return text;
     });
 
+    /**
+     * set paramater type.
+     */
+    Handlebars.registerHelper("setInputType", function(text) {
+          if (text === "File") {
+            return "file";
+          }
+          return "text";
+    });
+
     /**
      * start/stop timer for simple performance check.
      */

diff --git a/template/utils/send_sample_request.js b/template/utils/send_sample_request.js
@@ -53,8 +53,7 @@ define([
         // create JSON dictionary of parameters
         var param = {};
         var paramType = {};
-        var bodyFormData = {};
-        var bodyFormDataType = {};
+        var bodyFormData = new FormData();
         var bodyJson = '';
         $root.find(".sample-request-param:checked").each(function(i, element) {
             var group = $(element).data("sample-request-param-group-id");
@@ -79,8 +78,10 @@ define([
                     }
                     if (contentType == "body-form-data"){
                         header['Content-Type'] = 'multipart/form-data'
-                        bodyFormData[key] = value;
-                        bodyFormDataType[key] = $(element).next().text();
+                        if (element.type == "file") {
+                        value = element.files[0];
+                      }
+                      bodyFormData.append(key,value);
                     }else {
                         param[key] = value;
                         paramType[key] = $(element).next().text();
@@ -134,6 +135,11 @@ define([
             error      : displayError
         };
 
+        if(header['Content-Type'] == 'multipart/form-data'){
+            delete ajaxRequest.headers['Content-Type'];
+            ajaxRequest.contentType=false;
+            ajaxRequest.processData=false;
+        }
         $.ajax(ajaxRequest);