最佳实践

步骤 2. 创建并测试 API 服务

最近更新时间:2020-01-13 15:20:31

操作场景

在此部分中,将创建一个 API 网关中的服务和相关的 API 规则,对接在 步骤一 中已创建的 SCF 云函数,并通过控制台的 API 测试,来测试 API 的正确性。

注意:

API 服务和函数必须位于同一个地域下。在本教程中,将使用北京区域来创建 API 服务。

创建 API 服务及规则

  1. 登录 腾讯云控制台,选择页面上方的【云产品】>【中间件】>【API 网关】,进入 “API网关” 概览页。
  2. 选择左侧导航栏中的【服务】,并在“服务”页面上方切换地域为【北京】。
  3. 在“服务”页面中,单击【新建】按钮以新建 API 服务。如下图所示:
  4. 在弹出的“新建服务”窗口中,写入服务名 blogAPI 并单击【提交】创建。
  5. 完成服务创建后,进入已创建的 blogAPI 服务,选择【管理API】选项卡。如下图所示:
  6. 单击【新建】进入“新建API” 页面,在 “前端配置” 步骤中,参考以下主要参数信息进行创建 API:
    • API名称:自定义 API 名称。
    • 路径为 /article
    • 请求方法: GET。
    • 鉴权类型:为了方便后面的测试,选择【免鉴权】
      其余配置请保持默认设置,单击【下一步】。
  7. 在 “后端配置” 步骤中,参考以下主要参数信息进行创建 API:
    • 后端类型:选择为【cloud function】。
    • 云函数:选择函数为 步骤一 中已创建的 blogArticle 函数。
      其余设置请保持默认值,单击【下一步】。
  8. 在 “响应结果” 中单击【完成】即可完成 API 的创建。
  9. 再次在【管理API】选项卡中单击【新建】创建 API,路径为 /article/{articleId},请求方法为 GET,选择【免鉴权】,参数配置中输入名称为 articleId 的参数,参数位置为 Path,类型为 int,默认值为 1,单击【下一步】。
  10. 后端类型选择为【cloud function】,选择函数为 步骤一 中已创建的 blogArticle 函数,单击【下一步】。
  11. 在 “响应结果” 中单击【完成】即可完成 API 的创建。

调试 API 规则

  1. 针对前面 第6步 创建的 /article API,单击【API 调试】,在调试页面发送请求,确保返回结果内的响应 Body,为如下内容:
    [{"category": "blog", "time": "2017-12-05 13:45", "id": 1, "title": "hello world"}, {"category": "blog", "time": "2017-12-06 08:22", "id": 2, "title": "record info"}, {"category": "python", "time": "2017-12-06 18:32", "id": 3, "title": "python study"}]
  2. 针对前面 第9步 创建的 /article/{articleId} API,单击【API 调试】,在调试页面将请求参数修改为 1 后发送请求,确保返回结果内的响应 Body,为如下内容:
    {"category": "blog", "content": "first blog! hello world!", "time": "2017-12-05 13:45", "id": 1, "title": "hello world"}
  3. 也可以修改 第2步 中的请求参数 articleId 的值为其他数字,查看响应内容。
目录