youngerheart / restfulapi-sdk

standard restful api sdk with cache

restfulapi-sdk

build

standard restful api sdk with cache and promise.

What achieved

1. standard restful api sdk for get, post, put, delete, patch and options methods.
2. save data in browser side, use cache method.
3. promise callback.

usage

  $ npm install restfulapi-sdk
  $ bower install restfulapi-sdk // or use bower

Include sdk.js in /dist by tag , you can also require js by require('restfulapi-sdk')

  var urls = {
    order: '/api/order/:id',
    user: {
      password: '/api/user/:id/password'
    }
  };

  var config = {
    urlPrefix: 'api/', // you can add a urlPrefix, default ''
    cache: false, // open cache, default false (only valid with get method)
    cachePrefix: 'api', // cache prefix, default 'api'
    overdue: 3600, // cache time, unit second, default 3600
    overdueDay: null, // cache days number，prior to overdue，default null
    isSession: false // use sessionStorage for cache or not
  };

  const APISDK = require('restfulapi-sdk');
  const API = new APISDK(urls, config);

  var todo1 = API.order.get({
    id: id,
    otherRouteParams: ...
  });

  var todo2 = API.order.post({
    id: id,
    otherRouteParams: ...
  });

  // cache data with get method, will get remote data first
  API.order.cache({
    id: id,
    otherRouteParams: ...
  }).then((res, httpCode, refer) => {
    // success
    // do something
    refer(true, ...newRes); // arguments in next success()
    refer(false, ...newErr); // arguments in next error()
  }, (err, httpCode) => {
    // no data or overdue
  });

  APISDK.all([todo1, todo2])
  .then((successArr, errorArr, refer) => { // only trigger in success function
    // successArr[0] = [indexinPromiseArr, ...returnParams]
  });

  API.user.put({
    id: id
  }, {
    newPassword: newPassword
  }).then(() => {}, () => {}); // while use api data

  /*  static method for httpCode  */
  APISDK.httpCode((code) => {
    console.log(code);
  });

  /*  static method for remove Cache  */
  APISDK.remove(key, isSession); // cache key, and use sessionStorage for cache or not

develop

  $ clone restfulapi-sdk && make dev // then view http://localhost:8888

restfulapi-sdk's Issues

修复在cache禁用情况下仍有cache方法的问题

不能正确处理值为 0 的参数

形如 path/:id 的请求地址，当id参数值为0时该参数值不能被正确放入请求地址中。

提供 Content Type 配置

https://github.com/youngerheart/restfulapi-sdk/blob/master/src/http.js#L105

需要Content-type: application/json

需要清除某个缓存的方法

实现全局httpCode调用方法

实现APISDK.all方法

具体调用方式与实现需要细细考虑

实现自动化测试