EtiamOrbis/rest-api-helper

REST API Helper

Simple proxy layer for JavaScript fetch(). It helps do some http-requests excluding ugly boilerplate code and pretty cool logs support

Installation

npm i rest-api-helper

Usage

First thing first you need to configure helper.

• Create your_config_name.json.
• Define basic things for fetch:

It's like a

{
  "baseURL": "http://your.api.base.url/api/v1/",
  "logger": true
  "headers": {},
  "statusDescription": {
      "200": "OK",
      "401": "Invalid API token"
  },
  "successStatus": [
      200
  ],
  "request": {
     "getSomething": {
        "method": "get",
        "url": "something/get",
        "headers": {
           "Content-Type": "application/json",
           "Authorization": ""
        }
     }
  }
}

• Put your request's options in "request" property. Leave dynamic options as empty properties, like "Authorization".
• Call RestApiHelper.configure(require('path_to_your_config.json')); before fetch()
• Define yor API methods. Example:

async getSomething(request: SomeRequest) {

   RestApiHelper.setHeaders({
   	"Authorization": request.token,
   }, 'getSomething');
   
   let response = await RestApiHelper.fetch('getSomething');
   return new SomeResponse(response.body);
}

• Then call getSomething() wherever you need. Example:

getSomething(new SomeRequest(token)).then((response: SomeResponse) => {
   // do something
}).catch((error) => console.log(error));

Note:

We recommend using data models for greater code purity. Like we do - pass new SomeRequest() and return new SomeResponse()

Response object contains response body and response headers. If You need to know about response headers, just call response.headers besides response.body

Logger:

• If you need logs (which are pretty cool btw :)), set logger: true in config.json

Important for React-Native:

Logger might produce crashes at release builds or in debugger-off mode. Because that kind of logs supported only in V8 engine. We recommend use this hack before RestApiHelper.config():

config.logger = __DEV__ && Boolean(global.origin);
RestApiHelper.configure(config);

Then logger will be working only in dev mode and debug-on mode

• multipart/form-data example:

async uploadPhoto(file: File) {

   let formData = new FormData();
   formData.append('file', {
       uri: file.getUri()
   });
   formData.append('name', file.getName());
   
   RestApiHelper.setBody(formData, 'uploadFile');
   
   let response = await RestApiHelper.fetch('uploadFile');
   return new Response(response.body);
}

Don't forget declare "Content-type": "multipart/form-data" header for this kind of request

• if You need to use id parameter at some url's, do it like this:

//config.json
"get_something_by_id": {
        "method": "get",
        "url": "/something/{id}"
      }
      
...

async getSomethingById(id) {
    RestApiHelper.setIdParam(id, 'get_something_by_id'); // it automatically specify id parameter
    let response = await RestApiHelper.fetch('get_something_by_id');
    return new Response(response.body);
}

Specific url:

• If You need use a specific url for some requests, just put full url string in "url" property, like:

"getSomething": {
   "method": "get",
   "url": "http://your.api.specific.url/api/v1/something/get",
   "headers": {
      "Content-Type": "application/json",
      "Authorization": ""
   }
}

• If request throws error associated with an unsuccessful status (like 500), you can parse it and handle. For example:

...}).catch((error) => {
    console.log(error.name); // "bad" status, like 500
    console.log(error.description); // desc, like "Internal server error"
    console.log(JSON.parse(error.message)); // response body, like {error: 'Internal server error'}
});

Statuses not specified as "successStatus" in config.json will appears at catch()

TODO

• GET, POST, DELETE etc. support
• multipart/form-data support
• Logger
• Specific urls
• Support {id} param in url
• Response headers parsing
• XML support