apisauce

What is apisauce?

Apisauce is a library that simplifies the process of making HTTP requests in JavaScript applications. It is built on top of the popular axios library and provides a cleaner and more intuitive API for handling API requests and responses.

What are apisauce's main functionalities?

Creating an API instance

This feature allows you to create an API instance with a base URL and default headers. This instance can then be used to make various HTTP requests.

const { create } = require('apisauce');

const api = create({
  baseURL: 'https://api.example.com',
  headers: { Accept: 'application/json' },
});

Making GET requests

This feature allows you to make GET requests to the specified endpoint. The response object contains useful information such as the data, status, and any problems encountered.

api.get('/users').then(response => {
  if (response.ok) {
    console.log(response.data);
  } else {
    console.error(response.problem);
  }
});

Making POST requests

This feature allows you to make POST requests with a payload. The response object can be used to handle the result of the request.

api.post('/users', { name: 'John Doe', email: '[e-mail]' }).then(response => {
  if (response.ok) {
    console.log(response.data);
  } else {
    console.error(response.problem);
  }
});

Setting request and response transforms

This feature allows you to add transforms to requests and responses. Request transforms can modify the request before it is sent, and response transforms can modify the response before it is processed.

api.addRequestTransform(request => {
  request.headers['Authorization'] = 'Bearer token';
});

api.addResponseTransform(response => {
  if (!response.ok) {
    response.data = { error: 'Something went wrong' };
  }
});

Other packages similar to apisauce

axios

Axios is a promise-based HTTP client for the browser and Node.js. It is the underlying library that apisauce is built on top of. While axios provides a more general-purpose API, apisauce offers a more streamlined and opinionated interface for making API requests.

fetch

Fetch is a built-in JavaScript API for making HTTP requests. It is more low-level compared to apisauce and does not include features like request/response transforms or built-in error handling. Apisauce provides a higher-level abstraction with additional features.

superagent

Superagent is a small, progressive client-side HTTP request library. It provides a flexible API for making HTTP requests but does not include some of the higher-level features that apisauce offers, such as request/response transforms and built-in error handling.

README

The README file is missing