最佳实践

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

最近更新时间:2021-02-20 18:09:56

操作场景

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

注意:

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

创建 API 服务及规则

  1. 登录 API网关控制台,选择左侧导航栏中的【服务】。
  2. 在“服务”页面上方选择北京地域,并单击【新建】进入新建 API 服务页面。
  3. 在弹出的“新建服务”窗口中,设置以下参数信息,并单击【提交】创建服务。
    • 服务名blogAPI
    • 访问方式:选择“公网”。
  4. 在服务列表中选择已创建的 blogAPI 服务,进入“管理API”页。如下图所示:
  5. 单击【新建】进入“新建API” 页面,在“前端配置”步骤中,参考以下主要参数信息进行创建 API:
    • API名称:自定义 API 名称。
    • 路径为 /article
    • 请求方法:GET。
    • 鉴权类型:选择“免鉴权”。
      其余配置请保持默认设置,单击【下一步】。
  6. 在“后端配置”步骤中,参考以下主要参数信息进行创建 API:
    • 后端类型:选择“云函数SCF”。
    • 云函数:选择函数为 步骤1 中已创建的 blogArticle 函数。
      其余设置请保持默认值,单击【下一步】。
  7. 在“响应结果”中单击【完成】即可完成 API 的创建。在弹窗中选择“发布环境”为“测试”并选择【发布服务】。
  8. 再次在“管理API”页签中单击【新建】创建 API。如下图所示:
    • 路径为/article/{articleId}
    • 请求方法:GET。
    • 鉴权类型:选择“免鉴权”。
    • 参数配置:选择“新增参数配置”,并参考以下参数进行配置:
      • 参数名:articleId
      • 参数位置:Path
      • 类型:int
  9. 在“后端配置”步骤中,参考以下主要参数信息进行创建 API:
    • 后端类型:选择“云函数SCF”。
    • 云函数:选择函数为 步骤1 中已创建的 blogArticle 函数。
      其余设置请保持默认值,单击【下一步】。
  10. 在“响应结果”中单击【完成】即可完成 API 的创建。在弹窗中选择“发布环境”为“测试”并选择【发布服务】。

调试 API 规则

  1. 针对创建 API 服务及规则 步骤5 创建的 /article API,单击【调试】,在调试页面发送请求,确保返回结果内的响应 Body,为如下内容:
    [{"id": 1, "category": "blog", "title": "hello world", "time": "2017-12-05 13:45"}, {"id": 2, "category": "blog", "title": "record info", "time": "2017-12-06 08:22"}, {"id": 3, "category": "python", "title": "python study", "time": "2017-12-06 18:32"}]
  2. 针对创建 API 服务及规则 步骤8 创建的 /article/{articleId} API,单击【API 调试】,在调试页面将请求参数修改为1后发送请求,确保返回结果内的响应 Body,为如下内容:
    {"id": 1, "category": "blog", "title": "hello world", "content": "first blog! hello world!", "time": "2017-12-05 13:45"}
    说明:

    您可以修改请求参数 articleId 的值为其他数字,并查看响应内容。

目录