示例说明

最近更新时间:2018-08-28 16:04:29

本教程假设以下情况:

  • 您希望使用云函数来实现 Web 后端服务,例如提供博客内的文章查询和文章内容。
  • 您希望使用 API 来对外提供服务供网页和 APP 使用。

实现概要

下面是该服务的实现流程:

  • 创建函数,在 API 网关中配置 API 规则并且后端服务指向函数。
  • 用户请求 API 时带有文章编号。
  • 云函数根据请求参数,查询编号对应内容,并使用 json 格式响应请求。
  • 用户可获取到 json 格式响应后进行后续处理。

请注意,完成本教程后,您的账户中将具有以下资源:

  • 一个由 API 网关触发的 SCF 云函数。
  • 一个 API 网关中的 API 服务及下属的 API 规则。

本教程分为了三个主要部分:

  • 完成函数代码编写、函数创建和测试。
  • 完成 API 服务和 API 规则的设计,创建及配置。
  • 通过浏览器或 HTTP 请求工具测试验证 API 接口工作的正确性。

API 设计

现代应用的 API 设计通常遵守 Restful 规范,因此,在此示例中,我们设计获取博客文章的 API 为以下形式

  • /article GET
    返回文章列表

  • /article/{articleId} GET
    根据文章 id,返回文章内容