# gRPC Gateway JSON REST

在 irishub v1.0.0 中，节点继续提供 REST 服务。但是在 v0.16.3 和更早版本中存在的路由现在被标记为已弃用，并且已通过 gRPC-gateway 添加了新路由。

# API 激活方式和配置

所有路由均通过 ~/.iris/config/app.toml 中以下字段下配置：

• api.enable = true|false 字段定义是否启用 REST 服务，默认为 true。
• api.address = {string} 字段定义服务器应绑定到的地址（实际为端口，因为主机应保持在 0.0.0.0）。 默认为 tcp://0.0.0.0:1317。
• 在 ~/.iris/config/app.toml 中定义了一些其他 API 配置选项并附有注释，请直接参考该文件。

# gRPC-gateway REST 路由

如果由于各种原因而不能使用 gRPC（例如，您正在构建 Web 应用，且浏览器不支持 gRPC 依赖的 HTTP2），则 IRIShub 会通过 gRPC-gateway 提供 REST 路由。

gRPC-gateway 是将 gRPC 端点公开为 REST 端点的工具。对于 Protobuf 服务中定义的每个 RPC 端点，SDK提供了 REST 等效项。例如，可以通过 /irismod.token.Query/Tokens gRPC 端点，或者通过 gRPC-gateway /irismod/token/tokens REST 端点来查询 token 列表：两种方式返回的结果相同。对于 Protobuf 服务中定义的每个 RPC 方法，都定义了一个相应的 REST 端点作为可选项：

+++ https://github.com/irisnet/irismod/blob/master/proto/token/query.proto#L22

对于应用程序开发者，需要将 gRPC-gateway REST 路由连接到 REST 服务器，通过在 ModuleManager 上调用 RegisterGRPCGatewayRoutes 方法完成。

# Swagger

Swagger（或 OpenAPIv2 ）规范文件在 API 服务器上的 /swagger 路径下。 Swagger 是一个开放的规范，描述服务器服务的 API 端点，包括描述、输入参数、返回类型以及有关每个端点的更多信息。

可以通过 ~/.iris/config/app.toml 中的 api.swagger 字段配置启用 /swagger 端点，默认为 true。

对于应用程序开发人员，您可能希望基于自定义模块生成自己的 Swagger 定义。可以从 IRIShub 的 Swagger 生成脚本开始。

# API 端点

IRIShub API 端点

Tendermint API 端点

# 构造和签名交易

使用 REST 不能构造和签名交易，只能广播交易。您可以使用 gRPC 客户端 构造和签名交易。

# 广播交易

使用 gRPC-gateway REST 端点 cosmos/tx/v1beta1/txs 广播交易可以通过发送 POST 请求来完成，如下所示，其中 txBytes 是已签名交易的 protobuf 编码的字节数组：

curl -X POST \
    -H "Content-Type: application/json" \
    -d'{"tx_bytes":"{{txBytes}}","mode":"BROADCAST_MODE_SYNC"}' \
    "localhost:1317/cosmos/tx/v1beta1/txs"

# 查询交易

使用 gRPC-gateway REST 端点查询事务可以通过发送 GET 请求来完成，示例如下所示：

• Query tx by hash: /cosmos/tx/v1beta1/txs/{hash}

  curl -X GET \
      -H "accept: application/json" \
      "http://localhost:1317/cosmos/tx/v1beta1/txs/{hash}"
  

• Query tx by events: /cosmos/tx/v1beta1/txs

  curl -X GET \
      -H "accept: application/json" \
      "http://localhost:1317/cosmos/tx/v1beta1/txs?events={event_content}"