https://github.com/paysera/js-lib-http-client-common
https://github.com/paysera/js-lib-http-client-common
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/paysera/js-lib-http-client-common
- Owner: paysera
- Created: 2017-08-16T09:13:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T14:14:45.000Z (about 1 year ago)
- Last Synced: 2024-12-22T14:05:01.482Z (5 months ago)
- Language: JavaScript
- Size: 607 KB
- Stars: 4
- Watchers: 13
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @paysera/http-client-common
[Axios](https://github.com/axios/axios) requests wrapper.
Basically we use this library in our [generated JS clients from RAML](https://github.com/paysera/util-raml-code-generator).
## Installation
```shell
npm i @paysera/http-client-common
```
Include files:
```html
```
#### Dependencies
* [`axios`](https://github.com/mzabriskie/axios)
* [`store.js`](https://github.com/marcuswestin/store.js/)
## Usage
#### Without any middleware
```js
import { createClient, createRequest } from '@paysera/http-client-common';
const client = createClient({
baseURL: 'https://demo.com',
});
client.performRequest(createRequest('get', '/list'));
```
#### With JWT authentication middleware(with session storage token provider)
In this example `client.performRequest` makes request with `Authorization: 'Bearer {accessToken}'` header
```js
import {
createClient,
createRequest,
JWTAuthenticationMiddleware,
SessionStorageTokenProvider,
Scope,
} from '@paysera/http-client-common';
const client = createClient({
baseURL: 'https://{shard_id}.demo.com/{locale}', // base url with parameters
middleware: [
new JWTAuthenticationMiddleware(
new Scope('scope:a'),
new SessionStorageTokenProvider(
(scope) => ({ scope, accessToken: 'created-token' }),
(scope) => ({ scope, accessToken: 'refreshed-token' }),
'unique',
'namespace',
),
),
],
options: {
urlParameters: {
// list of url parameters
}
}
});
client.performRequest(createRequest('get', '/list'));
```
## Write your own middleware
```js
class MyCustomMiddleware {
async onRequest(config) {
// here you can make some changes to config object
return config;
}
async onResponseError(error) {
// here you can make some changes to error response
return error;
}
}
```
Under the hood middleware use `axios` interceptors, so basically middleware is wrapper for `axios` interceptors. More about `axios` interceptors you can read [here](https://github.com/axios/axios#interceptors)
* `onRequest(config)` - will be called every time before making request.
* `onResponseError(error)` - will be called every time after request returns error
## Demo run
```shell
npm run dev
```
## Build
```shell
npm run build
```