npm 包 @aws-amplify/api-rest 使用教程

前言

AWS Amplify 提供了许多用于构建应用程序和服务的库和工具包，其中 @aws-amplify/api-rest 是其中一个可以用来访问 REST API 的 npm 包。本文将介绍该 npm 包的使用方法，并提供代码示例供读者参考。

安装

使用 npm 命令安装：

npm install @aws-amplify/api-rest

配置

在使用 @aws-amplify/api-rest 模块的方法之前，需要通过以下方式对其进行配置：

import Amplify, { API } from 'aws-amplify';
import awsconfig from './aws-exports';

Amplify.configure(awsconfig);

const apiName = 'exampleAPI';
const path = '/example';

其中 awsconfig 是 AWS Amplify 的配置文件，可以在文件中添加 API 节点来添加 REST API 的设置，如下所示：

-- -------------------- ---- -------
-
  ------ -
      ------------ -
          -
              ------- -------------
              ----------- ------------------------------------------------------------
          -
      -
  -
-

在以上示例配置中，我们定义了一个名为 exampleAPI 的 REST API 端点，并将其映射到 https://exampleapi.execute-api.us-west-2.amazonaws.com/dev。你需要将其替换为你自己的 API 端点定义。

使用

在 @aws-amplify/api-rest 中，提供了如下常用的请求方法：

GET

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

POST

const myInit = {
   body: {},
};

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

PUT

const myInit = {
   body: {},
};

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

DELETE

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

示例

以下是一个简单的示例，它演示了如何使用 @aws-amplify/api-rest 请求 REST API 并解析响应的数据。

-- -------------------- ---- -------
------ -------- - --- - ---- --------------
------ --------- ---- ----------------

-----------------------------

----- ------- - -------------
----- ---- - -----------

---------------- -----
  -------------- -- -
    ---------------------
  --
  ------------ -- --------------------

结论

本教程提供了有关如何使用 @aws-amplify/api-rest 的指南，其中包括包的安装、配置和使用方法。我们还演示了如何使用此 npm 包发出不同类型的请求，并提供了示例代码供参考。希望这篇文章能帮助读者更好地理解和使用 AWS Amplify 的 REST API。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f6f632aa9b7065299ccba77