API-Class

KO | EN

gitlite — search

#javascript #hacktoberfest #golang #android #machine-learning #rust #deep-learning #docker #macos #java #windows #kubernetes #openai #open-source

(★ 88)

A utility class for calling apis CRUD methods

File Explorer

Download Latest Version (.zip)

- API.js
- API.js
- test.js
.babelrc
.gitignore
package-lock.json
package.json
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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.

```javascript
const myAPI = new API({ url: '/api' })
```
### Endpoints
To add an endpoint, use the `.createEntity` method.

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

```

### Methods
All `API`'s endpoints have basic CRUD operations

```javascript
getAll(params, config)
getOne({ id }, config)
create(toCreate, config)
update(toUpdate, config)
delete({ id }, config)
```
### Q&A

How to pass headers to axios?

```javascript
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

API-Class

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

API-Class

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README