API Wrapper

Installation

npm i @single9/api-wrapper

Usage

const ApiWrapper = require('@single9/api-wrapper');

Create

const api = new ApiWrapper([
 {
 name: '<Api Name>', // only allow certain words and digits
 path: '<Api Path>', // e.g. /api/posts
 method: '<HTTP Method>', // e.g. post or POST
 },
], {
 configureAxios(axios){
 // The axios you can add interceptors or global functions.
 },
 baseUrl: '<Base URL of API>', // e.g. https://jsonplaceholder.typicode.com
 // Default: http://localhost:3000
 headers: {
 // The headers you want to send. e.g. 'authorization': 'Bearer SAdoweasd...',
 },
 auth: { // authorization
 username: 'username',
 password: 'password',
 }
})

Factory baseUrl

const api = new ApiWrapper([
 {
 name: '<Api Name>', // only allow certain words and digits
 path: '<Api Path>', // e.g. /api/posts
 method: '<HTTP Method>', // e.g. post or POST
 },
], {
 baseUrl: async () => resolveSRV(process.env.API_HOST),
});

Use

api.<api_name>(params)

Params

params.queryString

api.test({
 queryString: {
 key: value
 }
})

api.test({
 queryString: [
 {
 name: string,
 value: string | number,
 }
 ]
})

params.pathParams

api.test({
 pathParams: {
 key: value
 }
})

api.test({
 pathParams: [
 {
 name: string,
 value: string | number,
 }
 ]
})

Example

const ApiWrapper = require('@single9/api-wrapper');
// Create your API schema
const schema = [
 {
 name: 'newPost', // this is your api function name
 path: '/posts',
 method: 'post',
 },
 {
 name: 'getTodo',
 path: '/todos/:todoId', // path parameter
 method: 'get',
 },
];
const api = new ApiWrapper(schema, {
 configureAxios(item){
 item.interceptors.request.use(
 (request) => { console.log('url: %s , req: %o', request.url); return request; },
 )
 item.interceptors.response.use(
 (response) => { console.log('url: %s , res: %o', response.url, response.data); return response; },
 )
 },
 baseUrl: 'https://jsonplaceholder.typicode.com',
});
async function start() {
 try {
 const post = await api.newPost({
 // Post Body
 data: {
 title: 'foo!!!!!!',
 body: 'bar!!',
 userId: 1
 },
 });
 console.log(post.data);
 const get = await api.getTodo({
 pathParams: {
 todoId: 2, // replace `:todoId` with value 2.
 },
 });
 console.log(get.data);
 } catch (err) {
 console.error(err);
 }
}
start();