跳到主要内容
版本:3.8.x

发布你的第一个 API

本教程介绍如何在 API7 企业版中发布并验证一个简单的 API。你将完成以下步骤:

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

前提条件​

  1. 安装 API7 企业版。
  2. 根据你的环境部署网关实例:
    1. 要在 Kubernetes 中部署 API7 网关并使用 Ingress Controller,请完成在 Kubernetes 上部署网关和 Ingress Controller。
    2. 要在 Docker 中部署 API7 网关,请按照新增网关实例中的 Docker 步骤操作。

创建服务和路由​

创建服务

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

创建路由

  1. 点击上一步创建的服务,然后点击新增路由。
  2. 在新增路由对话框中,执行以下操作:
    • 在名称字段中输入 get-ip。
    • 在路径字段中输入 /ip。
    • 在方法字段中选择 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 文件。
    • 在上游协议和服务类型字段中保留默认设置 HTTP。
    • 在如何查找上游字段中保留默认设置 使用节点。
    • 点击新增节点。
    • 在新增节点对话框中,执行以下操作:
      • 在主机字段中输入 httpbin.org。
      • 在端口字段中输入 80。
      • 在权重字段中输入 100。
    • 点击下一步。
  4. 点击新增。这将创建一个处于“无版本”状态的新服务。基本信息和标签会被导入,OpenAPI 文件中的所有路径都会转换为服务中的路由。

以下互动演示介绍如何通过导入 OpenAPI 添加服务。点击并按照演示步骤操作,可以进一步了解如何在 API7 企业版中使用该功能。

相关阅读​