api-class

0.0.6 • Public • Published

API Class

faster way to generate API calls with axios

Installation

You can install the package using npm

npm install api-class

https://www.npmjs.com/package/api-class

Usage

Create an API instance by import the API class from api-class. As parameter pass the basic url of your api.

const myAPI = new API({ url: '/api' })

Endpoints

To add an endpoint, use the .createEntity method.

const myAPI = new API({ url: '/api' })
myAPI.createEntity({ name : 'posts' })
myApi.endpoints.posts.getAll()
 

Methods

All API's endpoints have basic CRUD operations

getAll({ query }, config)
getOne({ id }, config)
create(toCreate, config)
update(toUpdate, config)
delete({ id }, config)

Q&A

How to pass headers to axios?

const myAPI = new API({ url: '/api' })
myAPI.createEntity({ name : 'posts' })
myAPI.endpoints.posts({ id: 0 },  { headers: {....} } )

You can check it out my medium article for further informations

https://medium.com/@FrancescoZ/how-to-call-api-in-a-smart-way-2ca572c6fe86

Readme

Keywords

none

Package Sidebar

Install

npm i api-class

Weekly Downloads

2

Version

0.0.6

License

ISC

Unpacked Size

8.64 kB

Total Files

6

Last publish

Collaborators

  • vae_victis