api返回的数据结构_【知晓云 API Gateway】API 乐队指挥家，网关服务正式上线

作者：繁依Fanyi0 | 2024-02-16 03:01:11

踩

云上的api只能返回几行数据怎么办

作者：知晓云资深工程师 John Deng

随着知晓云小伙伴们业务的发展，对我们服务的支持又有了新的要求，比如在对接第三方服务时，需要自定义数据结构等。为此，经过 32 次的需求讨论会以及工程师们的紧张开发后，知晓云 API 网关诞生了。你可以通过可视化界面配置 API ，点击发布，即可完成一个对外服务的 API，再也无需等待构建/部署流程，大大节约了开发成本。

知晓云 API 网关（API Gateway），是 API 发布、管理、运维的全生命周期管理工具。让开发者通过可视化界面配置并生成 API 提供给全平台使用，省掉了繁琐的服务开发及部署环节，五分钟即可完成 API 定制开发。

使用 API 网关，还可以让运行在知晓云上的应用数据得以更加灵活地提供给外部系统集成，无需再通过知晓云的 OpenAPI 进行数据转接，使得业务推进速度跃升一个等级。

API 网关的使用场景

1.接收外部系统回调

API 网关会将外部系统的回调内容传递至后端服务（云函数），处理完成后，还可以返回符合外部系统要求的内容。

2.定制 API 接口，自定义返回内容

直接使用知晓数据表相关的 API 时，无法对其返回内容进行自定义，更加无法应对涉及多表数据合成为一个对象返回的场景。使用 API 网关即可在云函数中组装好内容，通过其自定义返回内容的能力，将符合业务的数据格式返回到客户端。

API 网关的执行流程

客户端对 API 发起请求后，由网关进行有效性及路由匹配，将请求转发到后端服务进行业务处理，再把后端服务的内容通过 API 网关返回客户端。

PS：目前后端服务仅支持云函数。

需要注意：

云函数运行方式为同步，超时时间为 1.5 秒。

由于云函数需要告知 API 网关返回内容，因此云函数必须返回以下数据结构，如不按照这结构返回，API 网关将会响应错误：


{
  "status_code": 200,
  "content-type": "text/plain",
  "content": "hello, world!"
}

status_code 为响应请求的状态码。查看参考文档
content 为响应内容
content-type 为响应内容的类型，支持：
- text/plain（纯文本）
- text/html（HTML）
- application/json（JSON）
- application/xml（XML）