@beancommons/http

General HTTP Request module, extension from axios.

Install

npm install --save @beancommons/http

Usage

import http from '@beancommons/http';
var promise = http({
    baseURL: 'http://beancommons.com',
    url: '/getUser',
    params: {
        id: 1
    }
});
promise.then((data) => {

}, (error) => {

});

// return a handled url 'http://beancommons.com/getUser?id=1'
var url = http({
    baseURL: 'http://beancommons.com',
    url: '/getUser',
    params: {
        id: 1
    },
    returnType: 'url'
});
window.open(url);

// add proxy path, will request current domain 'http://localhost:xx/api/beancommons.com/setUser'
var promise = http({
    method: 'POST',
    baseURL: 'http://beancommons.com',
    url: '/setUser',
    data: {
        name: 'stephen',
        age: 30
    },
    proxyPath: '/api',
    enableProxy: true
});

Setup global options

// need setup before invoke http()
http.defaults = {
    method: 'POST',                                      // default is 'GET'
    contentType: 'application/x-www-form-urlencoded',    // default is 'application/json'
    cache: true,                                         // default is false
    proxyPath: '/api',                                   // default is '/proxy'
    enableProxy: __DEV__,
    isDev: __DEV__
};

Use Proxy(optional)

@beancommons/proxy is Easy to config webpack devServer proxy or http-proxy-middleware options.

npm install -D @beancommons/proxy

app.js

import http, { proxyBaseURL } from '@beancommons/http';
http.defaults = {
    proxyPath: proxyBaseURL,
    enableProxy: true,
    ...
};

webpack.config.dev.js

import { proxy } from '@beancommons/proxy';
{
    devServer: {
        ....
        proxy: {
            ...proxy('http://beancommons.com')  // you chould config this in package.json file
        }
    }
    ...
}

API

/**
 * @desc 使用axios第三方库访问后台服务器, 返回封装过后的Promise对象.
 * @param {axios.options...} 支持全系axios参数.
 * @param {boolean} cache 是否开启缓存, 开起后每次请求会在url后加一个时间搓, 默认false.
 * @param {function} cancel 封装了CancelToken
 * @param {string} contentType HTTP请求头的 Content-Type, 默认为'application/json'
 * @param {string} returnType 方法返回的数据类型, 可选: 'promise', 'url', 默认为 promise.
 * @param {function} requestInterceptor 封装了axios的interceptors.request.use().
 * @param {function} responseInterceptor 封装了axios的interceptors.response.use().
 * @param {function} resolveInterceptor 在resolve之前拦截resolve, 可进一步根据返回数据决定是resolve还是reject.
 * @param {function} onError 在请求返回异常时调用.
 * @param {boolean} enableProxy 是否开启代理服务, will replace baseURL with proxyPath, default is false.
 * @param {string | function} proxyPath proxy path, can be string or function, the function receive a options args and return a string, default is "/proxy."
 * @param {boolean} isDev 是否为调试模式, 调试模式会打一些log.
 * @param {object} extension custom data field
 * @return {object} - 返回一个promise的实例对象.
 */
http(options)
/**
 * @desc rewrite baseURL like 'http://beancommons.com' to '/proxy/beancommons.com' for proxy path matching
 */
proxyBaseURL(options, prefix = 'proxy')