base-support-api v1.0.4

base-support-api

安装

npm install base-support-api

使用

• 引用

  var RequestApi = require("base-support-api")
  // new RequestApi(options);
  var api = new RequestApi({
      actions: {
          backInitIndex: {
                options: {},
                params: {},
              url: ""
          }
      },
      baseUrl: "",
      suffix: ".json",
      isProduction: process.env.NODE_ENV === 'production',
      stringApi: false,
      headers: {
          "Content-Type": "application/x-www-form-urlencoded"
      }
  });

• 调用

  1. 基本用法

     // api.action(url, params, callback, options);
     api.action("", {}, function(){}, {});
     // api.get(url, params, callback, options);
     api.get("", {}, function(){}, {});
     // api.post(url, params, callback, options);
     api.post("", {}, function(){}, {});

  2. action别名用法

     // api[actionKey](params, callback, options);
     api.backInitIndex({}, function(){}, {});
     // api[actionKey].get(params, callback, options);
     api.backInitIndex.get({}, function(){}, {});
     // api[actionKey].post(params, callback, options);
     api.backInitIndex.post({}, function(){}, {});
     // api[actionUrl驼峰](params, callback, options);
     api.backendCommonBackInitIndex({}, function(){}, {});
     // api[actionUrl驼峰].get(params, callback, options);
     api.backendCommonBackInitIndex.get({}, function(){}, {});
     // api[actionUrl驼峰].post(params, callback, options);
     api.backendCommonBackInitIndex.post({}, function(){}, {});
     // api[actionUrl](params, callback, options);
     api[""]({}, function(){}, {});
     // api[actionUrl].get(params, callback, options);
     api[""].get({}, function(){}, {});
     // api[actionUrl].post(params, callback, options);
     api[""].post({}, function(){}, {});

  3. 增强字符串用法，stringApi: true，actions配置以后开启

     //"${key}".GET(params, callback, options)
     //"${key}".POST(params, callback, options)
     "".GET({}, function(){}, {});
     "".POST({}, function(){}, {});
     //如果包含url属性，增加url命名调用
     //"${url}".GET(params, callback, options)
     //"${url}".POST(params, callback, options)
     "".GET({}, function(){}, {});
     "".POST({}, function(){}, {});
     //"${url驼峰}".GET(params, callback, options)
     //"${url驼峰}".POST(params, callback, options)
     "".GET({}, function(){}, {});
     "".POST({}, function(){}, {});

  4. 所有调用支持返回Promise对象

     //then和catch区别于response.success
     "".GET().then().catch();

• 参数说明

  1. new RequestApi(options)，options说明

     参数	说明	类型	默认值
     baseUrl	接口默认地址，与传入的url组成访问地址	string	''
     suffix	接口默认访问地址后缀名	string	''
     isProduction	是否是正式环境	boolean	false
     stringApi	是否启用增强字符串的接口调用方式	boolean	false
     actions	action访问方式配置	object	{}

  2. actions的value配置说明

     参数	说明	类型	默认值
     url	接口地址，如果为''接口地址默认为对象的key	string	''
     params	接口调用的参数	object	{}
     options	接口调用的配置参数，同调用用法的options配置	object	{}

  3. options参数说明

     参数	说明	类型	默认值
     method	接口调用的方式	enum	RequestApi.method.GET
     callback	回调函数	Function	function(){}
     isMock	是否使用mock方式，isProduction为true不启用	boolean	true

  4. RequestApi.method说明

     参数	说明	类型	默认值
     GET	jquery的get方式	string	'GET'
     POST	jquery的post方式	string	'POST'

• jquery模块

  1. jquery模块

     core,sizzle,attributes,css,data,effects,event,exports,manipulation,queue,traversing,wrap,serialize,offset,dimensions,deprecated,callbacks

  2. jquery.ajax.js

     grunt custom:-sizzle,-attributes,-css,-data,-effects,-event,-manipulation,-queue,-traversing,-wrap,-serialize,-offset,-dimensions,-deprecated