https://github.com/zivl/restful-js
Simple and generic JavaScript class to handle REST API calls
https://github.com/zivl/restful-js
Last synced: 10 months ago
JSON representation
Simple and generic JavaScript class to handle REST API calls
- Host: GitHub
- URL: https://github.com/zivl/restful-js
- Owner: zivl
- License: mit
- Created: 2016-09-10T08:19:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T13:43:08.000Z (over 8 years ago)
- Last Synced: 2025-07-27T19:54:48.537Z (11 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Restful JS
[](https://travis-ci.org/zivl/restful-js)
[](https://badge.fury.io/js/restful-js)
A simple and generic way to handle RESTful API calls in your JavaScript application.
There are many libraries and utilities classes which provide RESTful implementation in JavaScript to handle API calls to server. Unfortunately, those other solutions, as good as they are, not always suits for everyone. Sometimes, the willing to do everything, just makes it more complex and harder to use.
This `restful-js` solution, keeps stuff the most simple there is, and exposes a nice and easy interface for use in your app.
In case of customized logic, there are some hook methods you can override
### Install
```
npm install restful-js --save
```
### How to use
***`fetch(url, options)`*** or ***`get(url, options)`***
Sends ***HTTP GET*** request with the following parameters:
`url: String` - the URL resource.
`options: Object` - All of the `ajax` options you would like to provide.
***`post(url, data, options)`***
Sends ***HTTP POST*** request with the following parameters:
`url: String` - the URL resource.
`data: Any` - The data you would like to send to the server.
`options: Object` - All of the `ajax` options you would like to provide.
***`put(url, data, options)`***
Sends ***HTTP PUT*** request with the following parameters:
`url: String` - the URL resource.
`data: Any` - The data you would like to send to the server.
`options: Object` - All of the `ajax` options you would like to provide.
***`destroy(url, options)`***
Sends ***HTTP DELETE*** request with the following parameters:
`url: String` - the URL resource.
`options: Object` - All of the `ajax` options you would like to provide.
### Different ways to use
##### As a Singelton
By default, an instance of the restful-js object is exported and ready to use.
For example:
```
import RestApi from 'restful-js';
// later on...
RestApi.fetch('some/url/resource').then(response => { /* handle response */ });
```
##### As a Class
You may also get a class and instantiate it yourself and manage it's life-cycle.
For example:
```
import {RestfulAPI} from 'restful-js';
// later on...
let restfulAPI = new RestfulAPI();
restfulAPI.fetch(`${baseUrl}/users`).then(response => { /* handle response */ });
```
##### Add event handlers
You may instantiate a class and give different handlers for XHR events.
For example:
```
import {RestfulAPI} from 'restful-js';
// later on...
let restfulAPI = new RestfulAPI({
errorResponseHandler: (xhr, textStatus, errorThrown) => {...}
ajaxStartHandler: () => {...},
ajaxStopHandler: () => {...}
});
```
##### Inherit and add you own customization
You can easily customize some behavioural stuff by inheriting from the exported `RestfulAPI` and add your own logic.
For example:
```
import {RestfulAPI} from 'restful-js';
class MyRestfulAPI extends RestfulAPI {
applySecurity(options, data){
// add some security logic
}
}
```
##### Get a jQuery reference
You may get a `jQuery` reference for your own usage and event handling
For example:
```
import {RestfulAPI} from 'restful-js';
const restfulAPI = new RestAPIUtil();
// jQuery binary transport to download files through XHR
restfulAPI.$.ajaxTransport('+binary', () => {...})
```
### Having some trouble? Have an issue?
For bugs and issues, please use the [issues](https://github.com/zivl/restful-js/issues) page.
### Road map
* Add support for more HTTP methods
* Remove the need of `jQuery.ajax` and use the global `fetch` way! (waiting for full browser support)
### Contribute
Sure! just fork this repository and join in!