@aws-amplify/api

What is @aws-amplify/api?

@aws-amplify/api is a part of the AWS Amplify library that provides a simple and powerful way to interact with AWS services such as AWS AppSync and REST APIs. It allows developers to easily integrate serverless backend services into their applications.

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

GraphQL API

This feature allows you to interact with GraphQL APIs, such as AWS AppSync. The code sample demonstrates how to query a list of todos from a GraphQL API.

const { API, graphqlOperation } = require('@aws-amplify/api');

const query = `query ListTodos {
  listTodos {
    items {
      id
      name
      description
    }
  }
}`;

API.graphql(graphqlOperation(query)).then(response => {
  console.log(response.data.listTodos.items);
}).catch(error => {
  console.error(error);
});

REST API

This feature allows you to interact with REST APIs. The code sample demonstrates how to make a GET request to a REST API endpoint.

const { API } = require('@aws-amplify/api');

const apiName = 'myApiName';
const path = '/items';
const myInit = { // OPTIONAL
  headers: {}, // OPTIONAL
  response: true // OPTIONAL (return the entire Axios response object instead of only response.data)
};

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

API Configuration

This feature allows you to configure API endpoints. The code sample demonstrates how to configure a REST API endpoint with AWS Amplify.

const Amplify = require('@aws-amplify/core').default;
const config = {
  API: {
    endpoints: [
      {
        name: 'myApiName',
        endpoint: 'https://api.example.com',
        region: 'us-east-1'
      }
    ]
  }
};

Amplify.configure(config);

Other packages similar to @aws-amplify/api

axios

Axios is a popular promise-based HTTP client for the browser and Node.js. It provides a simple API for making HTTP requests and is often used for interacting with REST APIs. Unlike @aws-amplify/api, it does not provide built-in support for AWS services or GraphQL APIs.

apollo-client

Apollo Client is a comprehensive state management library for JavaScript that enables you to manage both local and remote data with GraphQL. It is specifically designed for working with GraphQL APIs and offers more advanced features for caching and state management compared to @aws-amplify/api.

fetch

Fetch is a native JavaScript API for making HTTP requests. It is a low-level API that provides a more flexible and modern way to make network requests compared to older XMLHttpRequest. However, it lacks the higher-level abstractions and built-in AWS integrations provided by @aws-amplify/api.

README

INTERNAL USE ONLY

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