跳到主要内容
版本:3.2.16.6

创建你的第一个 API

本教程介绍如何在 API7 网关上启动并验证一个简单的 API。你将完成以下步骤。

  1. 创建一个已发布的服务,为它配置路由和指向 httpbin 的上游。
  2. 发送请求,验证创建的 API。

前提条件​

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

启动一个示例上游服务​

如果你在 Kubernetes 上运行 API7 网关,请在本节中将 httpbin 应用部署到集群,作为上游服务示例。否则,请跳到下一节,使用托管的 httpbin 应用作为上游。

启动一个 httpbin 应用作为示例。

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

你应看到 pod/httpbin created 响应。

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

kubectl expose pod httpbin --port 80

你应看到 service/httpbin exposed 响应。

创建服务与路由​

创建服务

  1. 在侧边栏选择目标网关组下的 已发布服务,然后点击 新增服务。
  2. 选择 手动新增。
  3. 在 新增服务 对话框中完成以下操作。
    • 在 名称 字段中输入 httpbin。
    • 在 服务类型 字段中选择 HTTP(七层代理)。
    • 在 上游 Scheme 字段中选择 HTTP。
    • 在 如何找到上游 字段中选择 使用节点。
    • 点击 新增节点。
    • 在 新增节点 对话框中完成以下操作。
      • 在 主机 字段中输入 httpbin.org。
      • 在 端口 字段中输入 80。
      • 在 权重 字段中输入 100。
  4. 点击 新增。新建的服务处于“无版本”状态。

创建一条路由

  1. 点击刚刚创建的服务,然后点击 新增路由。
  2. 在 新增路由 对话框中完成以下操作。
    • 在 名称 字段中输入 get-ip。
    • 在 路径 字段中输入 /ip。
    • 在 HTTP 方法 字段中选择 GET。
    • 点击 新增。

以下交互式演示介绍如何创建无版本服务。你可以按照演示中的步骤了解如何在 API7 企业版中使用此功能。

验证 API​

向路由发送请求。

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

你应看到以下响应。

{
"origin": "127.0.0.1"
}

现在,你的第一个 API 已经开始运行。

导入 OpenAPI 以添加 API​

你也可以导入 OpenAPI 3.0 规范来添加 API。

创建服务

  1. 在侧边栏选择目标网关组下的 已发布服务,然后点击 新增服务。
  2. 选择 导入 OpenAPI。
  3. 在 新增服务 对话框中完成以下操作。
    • 在 OpenAPI 3.0 规范 字段中上传 httpbin.yaml 文件。
    • 在 上游 Scheme 和 服务类型 字段中保留默认设置 HTTP。
    • 在 如何找到上游 字段中保留默认设置 使用节点。
    • 点击 新增节点。
    • 在 新增节点 对话框中完成以下操作。
      • 在 主机 字段中输入 httpbin.org。
      • 在 端口 字段中输入 80。
      • 在 权重 字段中输入 100。
    • 点击 下一步。
  4. 点击 新增。新建的服务处于“无版本”状态。基本信息和标签会被导入,OpenAPI 文件中的所有路径都会转换为该服务的路由。

以下交互式演示介绍如何导入 OpenAPI 来添加服务。你可以按照演示中的步骤了解如何在 API7 企业版中使用此功能。

相关阅读​