@aws-amplify/api-rest

What is @aws-amplify/api-rest?

@aws-amplify/api-rest is a part of the AWS Amplify library that provides a simple and powerful way to interact with REST APIs. It allows developers to easily integrate their applications with AWS services and other RESTful endpoints.

What are @aws-amplify/api-rest's main functionalities?

GET Request

This feature allows you to make a GET request to a specified API endpoint. The code sample demonstrates how to fetch data from the '/items' endpoint of 'myApiName' API.

const apiName = 'myApiName';
const path = '/items';

API.get(apiName, path).then(response => {
  console.log(response);
}).catch(error => {
  console.error(error);
});

POST Request

This feature allows you to make a POST request to a specified API endpoint. The code sample demonstrates how to send data to the '/items' endpoint of 'myApiName' API.

const apiName = 'myApiName';
const path = '/items';
const myInit = {
  body: {
    itemName: 'NewItem'
  }
};

API.post(apiName, path, myInit).then(response => {
  console.log(response);
}).catch(error => {
  console.error(error);
});

PUT Request

This feature allows you to make a PUT request to a specified API endpoint. The code sample demonstrates how to update data at the '/items/1' endpoint of 'myApiName' API.

const apiName = 'myApiName';
const path = '/items/1';
const myInit = {
  body: {
    itemName: 'UpdatedItem'
  }
};

API.put(apiName, path, myInit).then(response => {
  console.log(response);
}).catch(error => {
  console.error(error);
});

DELETE Request

This feature allows you to make a DELETE request to a specified API endpoint. The code sample demonstrates how to delete data at the '/items/1' endpoint of 'myApiName' API.

const apiName = 'myApiName';
const path = '/items/1';

API.del(apiName, path).then(response => {
  console.log(response);
}).catch(error => {
  console.error(error);
});

Other packages similar to @aws-amplify/api-rest

axios

Axios is a popular promise-based HTTP client for the browser and Node.js. It provides a simple and easy-to-use API for making HTTP requests. Compared to @aws-amplify/api-rest, Axios is more general-purpose and not specifically tied to AWS services.

fetch

Fetch is a built-in JavaScript API for making HTTP requests. It is widely supported in modern browsers and provides a simple and flexible way to interact with RESTful endpoints. Unlike @aws-amplify/api-rest, Fetch is not specific to AWS and does not include built-in support for AWS services.

superagent

Superagent is a small, progressive client-side HTTP request library. It has a simple API and supports features like automatic serialization of JSON and form data. Superagent is more lightweight compared to @aws-amplify/api-rest and is not tied to AWS services.

README

INTERNAL USE ONLY

This package contains the AWS Amplify API REST category and is intended for internal use only. To integrate Amplify into your app, please use aws-amplify.