axios-rest's Introduction

Axios Rest

A simple axios wrapper to make rest api call delightful.

Example

const axiosRestClient = require('axios-rest-client')
const api = axiosRestClient({baseUrl: process.env.API_BASE_URL})

// Get all users
api.users.all().then(response => {
  console.log(response.data)
})

// Create new user
api.users.create({
  firstname: 'John',
  lastname: 'Doe'
})

Installation

npm install --save axios-rest-client

axios-rest require axios to work, so you have to install axios

npm install --save axios

How to use it ?

Create your axios rest client

const axiosRestClient = require('axios-rest-client')

const api = axiosRestClient({
  baseUrl: process.env.API_BASE_URL // this is required
  // see axios for other configuration options
})

And that all ! You can start requesting your api

Start by creating endpoint for your resources

// Create multiple resources endpoints
api.endpoints({
  users: 'users',           // /users endpoint
  posts: 'post-resources'  // /post-resources endpoint
})

api.endpoint('users')   // Create /users endpoint

// You can access previously endpoint as attribute
// If the endpoint does not exist it will be created automatically
api.users
api.comments    // get endpoint for comments on /comments

You can then call

api.users.all()               // GET /users
api.users.find(1)             // Get /users/1
api.users.create(data)        // POST /users, body=data
api.users.update(1, data)     // PUT /users/1, body=data
api.users.delete(1)           // DELETE /users/1

If you want to create an api endpoint for a single instance of a collection just call .one(instanceId) on the collection endpoint.

api.users.one(1)  // Create entity endpoint for user with id 1
// or simply do
api.users[1]      // to get the /users/1 endpoint automatically created for you

You can the call

api.users[1].get()        // GET /users/1
api.users[1].post(data)   // POST /users/1, body = data
api.users[1].put(data)    // PUT /users/1, body = data
api.users[1].delete()     // DELETE /users/1

axios-rest's People

Contributors

Stargazers

Watchers

axios-rest's Issues

Query Subpath after find()

Hey there,
is it possible to query urls like this:

http://localhost/document/4362010470902532462/content

where 4362010470902532462 is the ID of a specific document?

In code I would expect something like this (but of course this wont work currently):

let document = this.API.documents.find(documentId).content.all();

axiosRestClient is not a function

Hey there, looks cool but I had a problem initializing it.
When I tried to create an API object like in your example I get the following error:

The code that causes this is the following:

const axiosRestClient = require('axios-rest-client');
this.API = axiosRestClient({
  baseUrl: process.env.API_BASE_URL
});

I had to use this instead to make it work:

const axiosRestClient = require('axios-rest-client');
this.API = axiosRestClient.default({
  baseUrl: process.env.API_BASE_URL
});

Subpath POST

Is something like api.users[id].message.post({content:'message'}) supported by library?
Example code calls GET /users/{id}/message/post?content=message, but not POST ...
Great library!