@infotorg/api-client
v1.0.0
Published
API client for node.js and the browser (axios wrapper).
Downloads
380
Readme
api-client
Promised-based Api Client for node.js and the browser (axios wrapper). More info about options you can find in axios docs.
API documentation
Installation
$ npm install @infotorg/api-client
Usage
import axios from 'axios';
import { ApiClient } from '@infotorg/api-client';
// or for node.js
// const axios = require('axios');
// const { ApiClient } = require('@infotorg/api-client');
const apiClient = new ApiClient(axios, {
// Other options you can find in axios docs
baseURL: 'https://api.example.com',
headers: {
'Content-Type': 'application/json',
},
});
// GET request
const response = await apiClient.get('/users/1');
// POST request
const response = await apiClient.post('/users', {
name: 'John',
age: 30,
});
// PUT request
const response = await apiClient.put('/users/1', {
name: 'John',
age: 30,
});
// PATCH request
const response = await apiClient.patch('/users/1', {
name: 'John',
age: 33,
});
// DELETE request
const response = await apiClient.delete('/users/1');
// HEAD request
const response = await apiClient.head('/users/1');
// OPTIONS request
const response = await apiClient.options('/users/1');
Tests
Tests are written with jest
. They can be run with npm
:
npm run test