跳到主要内容
版本:3.2.16.3

创建一个简单的 API

本教程介绍如何创建一个简单的 API 并对其进行验证。你将完成以下步骤:

  1. 创建指向 httpbin.org服务,并为其创建路由上游
  2. 通过发送一个请求,验证创建的 API 是否正常工作。

前提条件

  1. 安装 API7 企业版
  2. 确保网关组中至少有一个网关实例。

启动一个示例上游服务

如果你想在 Kubernetes 上运行 API7 企业版,你需要将在本节中将一个 httpbin 应用部署到你的 Kunbernetes 集群中作为示例上游服务。否则,请跳到下一节,直接使用托管的 httpbin 应用作为上游。

启动一个 httpbin 应用:

kubectl run httpbin --image kennethreitz/httpbin --port 80

你应该会看到类似以下内容的响应:

pod/httpbin created`

通过服务暴露 httpbin 应用的 80 端口:

kubectl expose pod httpbin --port 80

你应该会看到类似以下内容的响应:

 `service/httpbin exposed`

创建服务与路由

创建服务

  1. 在左侧菜单选择目标网关组下的 已发布服务 菜单,然后点击 新增服务
  2. 选择 手动新增
  3. 在新增服务表单页中, 执行以下操作:
  • 名称 填写 httpbin
  • 服务类型 选择 HTTP (七层代理)
  • 上游 Scheme 选择 HTTP
  • 如何找到上游 选择 使用节点
  • 点击 新增节点
  • 在新增节点对话框中,执行以下操作:
    • 主机 填写 httpbin.org
    • 端口 填写 80
    • 权重 填写 100
  • 点击 新增。 此时创建出的新服务处于“无版本”状态。

创建一条路由

  1. 进入刚才创建好的服务,然后点击 新增路由
  2. 在新增路由对话框中,执行以下操作:
  • 名称 填写 getting-started-ip
  • 路径 填写 /ip
  • HTTP 方法 选择 GET
  • 点击 新增

验证 API

向刚才创建好的路由发送 API 请求:

curl "http://127.0.0.1:9080/ip"

你应该会看到类似以下内容的响应:

{
"origin": "127.0.0.1"
}

恭喜你,现在你的第一个 API 已经成功运行。

相关阅读