Hyperledger中的REST API

REST，即Representational State Transfer，是一种用于构建Web服务的架构风格。 它基于一系列原则来定义网络资源的如何被定义、访问以及操作。 REST的核心原则之一，就是使用HTTP协议来实现客户端与服务器之间的通信。 这意味着，REST API遵循与网络本身相同的原则，因此它们易于使用且得到了广泛的支持。 这篇文章主要讨论了Hyperledger中的REST API。

以下这些主题将会在这里被讨论：

1. 什么是REST API呢？
2. 安装 REST Server
3. 运行REST服务器
4. 更新REST服务器
5. REST API中的方法
6. REST API的实现代码

让我们先详细讨论一下这些话题吧。

什么是REST API？

REST API允许客户端应用程序与Hyperledger区块链网络进行交互。这样一来，客户端应用程序就可以对区块链执行各种操作，比如查询账本的状态、提交交易，或者查询特定资产的历史记录。这使得开发者能够以一种便捷且标准化的方式，来构建能够访问和操作区块链上数据的应用程序。

• 要使用 REST API 与 Hyperledger 进行交互，客户端应用程序必须先对区块链网络进行身份验证。
• 这通常涉及到向服务器提供一组认证信息，比如用户名和密码。
• 一旦客户端应用程序通过身份验证，它就可以向REST API发起请求，以对区块链执行各种操作。

REST API是用来做什么的？

REST API被广泛应用于各种场景，包括：

• 公开来自网络服务及其他应用程序的数据和功能。
• 允许应用程序之间进行通信并共享数据。
• 提供一个标准接口，使得不同的客户端能够使用该接口来访问服务器的资源。
• 实现不同系统和平台之间的互操作性。

REST API特别适用于构建需要访问其他服务中的数据或功能的基于Web的应用程序。例如，一个移动应用可以从服务器中获取数据，或者一个基于Web的工具可以与其他服务集成以完成特定任务。
总体而言，REST API是一种非常重要的工具，它有助于构建现代网络应用程序，并促进不同系统和平台之间的通信。

安装 REST Server

要安装REST服务器，首先请确保系统上已经安装了Hyperledger平台。

1. 一旦 Hyperledger 安装完成之后，可以使用 npm 包管理器来安装 fabric-rest 包。该包为 Hyperledger 平台提供了一个 REST 服务器。要执行此操作，请运行以下命令：

运行命令：npm install fabric-rest

2.在软件包安装完成后，可以使用 `fabric-rest` 命令来启动 REST 服务器。需要为服务器提供相应的配置信息，比如 Hyperledger 网络的位置以及访问该网络的凭据。

运行REST服务器

1. 一旦软件安装完成，就可以使用 `fabric-rest` 命令来启动服务器。该命令包含多个选项和参数，这些参数可以用来配置服务器，同时还可以指定 Hyperledger 网络的位置以及访问该网络的凭据。
以下是如何使用 `fabric-rest` 命令来启动 REST 服务器的示例：

fabric-rest --port 3000 --network./my-hyperledger-network --keystore./keystore --cacert./cacert.pem

2. 此命令将启动位于端口 3000 的 REST 服务器，该服务器使用指定的 Hyperledger 网络、密钥存储库以及证书。您可以通过在本地机器上向指定端口发送 HTTP 请求来访问该服务器。

更新REST服务器

1.一旦确认了“fabric-rest”包已经成功安装，请运行以下命令来将其更新到最新版本：

npm update fabric-rest

这将使 fabric-rest 包更新到 npm 注册表中最新可用的版本。

2. 更新完成后，请使用 `fabric-rest` 命令来启动 REST 服务器，然后像往常一样继续使用它。

REST API中的方法

在REST API中，最常用的几种方法包括：

• 获取：用于从服务器中提取数据。
• POST：过去，人们会向服务器发送数据，以创建新的资源。
• PUT：用于向服务器发送数据，以更新现有的资源。
• 删除：用于从服务器上删除某个资源。

这些方法通常会与一个URL一起使用，该URL指明了正在被访问或修改的资源的位置。

例如：

对 URL https://example.com/users/1 发起 GET 请求后，可以从服务器中获取ID为1的用户的数据。

向同一个URL发送POST请求时，可能会创建一个新的用户，该用户的ID为1。

除了这些常见的使用方法之外，某些 API 还可能支持其他方法。例如，可以使用 PATCH 方法来部分更新资源；而 HEAD 方法则用于仅获取响应的头部信息。具体使用哪些方法取决于该 API 的设计。

REST API的实现代码

以下是两个关于如何实现REST API的代码示例：

示例1：假设客户端应用程序向REST API发起请求，以查询账本当前的状态。此时，REST API会与区块链网络进行通信，从账本中提取相关信息，并以客户端能够理解的格式（如JSON）将其返回给客户端应用程序。

• 首先，客户端应用程序必须向区块链网络进行身份验证。这通常涉及向服务器提供一组认证信息，比如用户名和密码。
• 一旦客户端经过身份验证，它就可以向REST API发起请求，以对区块链执行各种操作。例如，它可以请求查询账本的当前状态。

GET /ledger HTTP/1.1
主持人：blockchain.example.com
内容类型：application/json

在这种情况下，REST API会与区块链网络进行通信，获取账本的当前状态，然后以JSON格式将这些信息返回给客户端。

HTTP/1.1 200 成功
内容类型：application/json

{
“账本”：{
“版本”：1
“资产”: [
     {
“id”: “asset1”
“所有者”：“Alice”
“价值”：100
     },
     {
“id”: “asset2”
“所有者”：“鲍勃”
“价值”：200
     }
   ]
 }
}

在这个例子中，客户端应用程序查询了账本中的当前状态，并获得了包含有关账本上资产及其当前所有者的信息的响应。

总结来说，REST API使得客户端应用程序能够以便捷且标准化的方式与Hyperledger区块链网络进行交互。这样一来，开发者就可以轻松地构建能够直接访问和操作区块链上数据的应用程序。

示例2：这是另一个例子，说明客户应用程序如何通过使用 REST API 与 Hyperledger 区块链网络进行交互。

• 首先，客户端应用程序必须向区块链网络进行身份验证。这通常涉及向服务器提供一组认证信息，比如用户名和密码。
• 一旦客户端经过身份验证，它就可以向REST API发起请求，以对区块链执行各种操作。例如，它可能会向账本提交一笔交易。

POST /transactions HTTP/1.1
主持人：blockchain.example.com
内容类型：application/json

{
“交易”：{
“assetId”: “asset1”
“新所有者”：“Carol”
 }
}

在这种情况下，REST API会接收来自客户端的交易请求，根据区块链网络的规则对交易进行验证。如果交易有效，那么REST API就会将该交易提交到账本中。之后，REST API会向客户端返回一份响应，告知该交易的状态。

HTTP/1.1 200 成功
内容类型：application/json

{
“状态”：“成功”
“消息”： “交易已成功提交到账本中。”
}

在这个例子中，客户端应用程序向账本中提交了一笔交易，目的是将某资产的所有权从一位用户转移到另一位用户。REST API接收了这笔交易后，对其进行验证，然后将其提交到账本中。之后，REST API返回了一个响应，表明这笔交易已经成功完成。

总结来说，REST API使得客户端应用程序能够与Hyperledger区块链网络进行交互，并以一种便捷且标准化的方式向区块链中提交交易。这样一来，开发者就可以轻松地构建出能够直接访问和操作区块链上数据的应用程序。