开发函数计算的正确姿势 —— 部署 API 网关

本文涉及的产品
Serverless 应用引擎免费试用套餐包,4320000 CU,有效期3个月
函数计算FC,每月15万CU 3个月
简介: 前言 首先介绍下在本文出现的几个比较重要的概念: 函数计算(Function Compute): 函数计算是一个事件驱动的服务,通过函数计算,用户无需管理服务器等运行情况,只需编写代码并上传。函数计算准备计算资源,并以弹性伸缩的方式运行用户代码,而用户只需根据实际代码运行所消耗的资源进行付费。

前言

首先介绍下在本文出现的几个比较重要的概念:

函数计算(Function Compute): 函数计算是一个事件驱动的服务,通过函数计算,用户无需管理服务器等运行情况,只需编写代码并上传。函数计算准备计算资源,并以弹性伸缩的方式运行用户代码,而用户只需根据实际代码运行所消耗的资源进行付费。函数计算更多信息参考

Fun: Fun 是一个用于支持 Serverless 应用部署的工具,能帮助您便捷地管理函数计算、API 网关、日志服务等资源。它通过一个资源配置文件(template.yml),协助您进行开发、构建、部署操作。Fun 的更多文档 参考

Api 网关: API 网关(API Gateway)提供高性能、高可用的 API 托管服务,帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用,提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作,即可快速、低成本、低风险地开放数据或服务。

函数计算提供了 HTTP 触发器,并且支持本地调试,使得通过函数计算开发一个 web 应用十分的方便。

但也存在一些场景,比如已经存在了一个 API 网关 + 函数计算的应用,想要将该应用部署到不同的 region。如果通过手工操作,这个过程会十分的繁琐,且容易出错。而通过 Fun 可以较容易的实现一键部署 API 网关 + 函数计算到所有 region。

本文,主要介绍如何通过 Fun 发布 Api 网关 + 函数计算应用。

在读本文前,建议阅读 Fun 工具相关的基础知识

注意: 本文只会附上核心的代码或配置,如果想要完整的例子,可以参考

简单的例子

编写函数代码

首先需要编写函数的代码,函数可以是一个简单的 helloworld:

exports.handler = function(event, context, callback) {
  var response = {
      isBase64Encoded: false,
      statusCode: 200,
      body: 'hellow wrold'
  };
  callback(null, response);
};
AI 代码解读

也可以是一段更复杂的程序,比如 这里 涉及到的代码。

配置 Api 网关

HelloworldGroup: # Api Group
  Type: 'Aliyun::Serverless::Api'
  Properties:
    StageName: RELEASE
    DefinitionBody:
      '/': # request path
        get: # http method
          x-aliyun-apigateway-api-name: hello_get # api name
          x-aliyun-apigateway-fc: # 当请求该 api 时,要触发的函数,
            arn: acs:fc:::services/${fc.Arn}/functions/${helloworld.Arn}/
            timeout: 3000
AI 代码解读

其中 x-aliyun-apigateway-fc 配置项中的 fc 以及 helloworld,分别为服务名、函数名,需要根据实际配置的函数进行修改。

发布

通过 Fun deploy 即可发布:

打开提示的 url 即可进行访问。

更多例子

在 Fun 项目中,提供了很多 API 网关的 demo 和文档,可以参考

使用进阶

如果已有的文档无法满足需求,比如想要配置 https、超时时间,必须按可选等参数,可以根据 API 网关的 API 文档 进行更多的配置,Fun 支持的参数包括但不限于 ApiName、Visibility、RequestConfig、RequestParameters、ServiceParameters、ServiceParametersMap 等。

如果想要通过 API 文档 编写 Fun 配置文件,就需要了解 API 与 Fun 配置的映射关系。映射规则如下:

将参数名小写,并将原来的驼峰用 - 连接,然后加上 x-aliyun-apigateway 前缀。

举例,比如对于一下几个 API 参数,映射关系分别为:

ApiName => x-aliyun-apigateway-api-name
Visibility => x-aliyun-apigateway-visibility
RequestParameters => x-aliyun-apigateway-request-parameters
ServiceParametersMap => x-aliyun-apigateway-service-parameters-map
AI 代码解读

另外,针对每一个参数,可以进一步进行更细粒度的配置,比如在 API 文档 上介绍了 RequestParameters 其实是一个 RequestParameter 的数组的字符串表示,而 RequestParameter 可进行的配置有 ApiParameterName、LocationParameterType、Required 等。

转换成 Fun 配置,只需要将首字母小写即可,比如:

ApiParameterName => apiParameterName
Location => location
AI 代码解读

映射示例

对于 RequestParameters 的配置,转换成 Fun 配置为:

x-aliyun-apigateway-request-parameters:
  - apiParameterName: 'token'
    location: 'Query'
    parameterType: 'String'
    required: 'REQUIRED'
  - apiParameterName: 'token2'
    location: 'Query'
    parameterType: 'String'
    required: 'REQUIRED'
AI 代码解读

在上面的例子中,配置了两个 Query 类型的必须按参数,其中,第一个参数名为 token,第二个为 token2。

常量参数、系统参数

根据 API 网关的文档,以及上面的映射规则,可以写出常量参数的配置如下:

x-aliyun-apigateway-request-parameters:
  - apiParameterName: 'token'
    location: 'Query'
    parameterType: 'String'
    required: 'REQUIRED'
    defaultValue: 'e'
x-aliyun-apigateway-service-parameters:
  - serviceParameterName: 'token'
    location: 'Query'
    parameterCatalog: 'CONSTANT'
AI 代码解读

同样可以写出系统参数的配置如下:

x-aliyun-apigateway-request-parameters:
  - apiParameterName: 'CaClientIp'
    location: 'Query'
    parameterType: 'String'
    required: 'REQUIRED'
x-aliyun-apigateway-service-parameters:
  - serviceParameterName: 'CaClientIp'
    location: 'Query'
    parameterCatalog: 'SYSTEM'  
AI 代码解读

改造已有的 API

如果已经存在了一个 API 网关的 API,如何快速的用 Fun 描述出来?

这里介绍一个技巧,打开 API 网关控制台,选择想要改造的 API,点击编辑,然后不做任何修改直接保存。

然后找到 ModifyApi.json 请求,可以看到 RequestParamters 等参数的配置:

image

将其按照上面的映射规则进行改写即可。

总结

本文介绍了通过 Fun 部署 API 网关以及函数计算的例子,如果应用比较简单可以直接复制这些例子的配置使用,如果提供的示例无法满足需求,可以通过本文介绍的映射规则进行自定义配置。

利用 Fun 配置 API 网关具有重复部署、多 region 部署、协同开发、版本控制管理等优点,推荐优先使用 Fun 部署 Api 网关。

目录
打赏
0
0
0
1
142
分享
相关文章
1688商品数据实战:API搜索接口开发与供应链分析应用
本文详细介绍了如何通过1688开放API实现商品数据的获取与应用,涵盖接入准备、签名流程、数据解析存储及商业化场景。开发者可完成智能选品、价格监控和供应商评级等功能,同时提供代码示例与问题解决方案,确保法律合规与数据安全。适合企业开发者快速构建供应链管理系统。
|
4天前
|
如何在苹果内购开发中获取App Store Connect API密钥-共享密钥理解内购安全-优雅草卓伊凡
如何在苹果内购开发中获取App Store Connect API密钥-共享密钥理解内购安全-优雅草卓伊凡
46 15
如何在苹果内购开发中获取App Store Connect API密钥-共享密钥理解内购安全-优雅草卓伊凡
前后端分离开发:如何高效调试API?有工具 vs 无工具全解析
在前后端分离开发中,API调试至关重要。本文探讨有无调试工具时如何高效调试API,重点分析Postman、Swagger等工具优势及无工具代码调试方法。通过实际场景如用户登录接口,对比两者特性。同时介绍Apipost-Hepler(IDEA插件),将可视化与代码调试结合,提供全局请求头配置、历史记录保存等功能,优化团队协作与开发效率,助力API调试进入全新阶段。
鸿蒙相机开发实战:从设备适配到性能调优 —— 我的 ArkTS 录像功能落地手记(API 15)
本文分享鸿蒙相机开发经验,从环境准备到核心逻辑实现,涵盖权限声明、模块导入、Surface关联与分辨率匹配,再到录制控制及设备适配法则。通过实战案例解析,如旋转补偿、动态帧率调节和编解码优化,帮助开发者掌握功能实现、设备适配与体验设计三大要点,减少开发坑点。适合鸿蒙新手及希望深化硬件交互能力的工程师参考收藏。
30 2
微店API开发全攻略:解锁电商数据与业务自动化的核心能力
微店开放平台提供覆盖商品、订单、用户、营销、物流五大核心模块的API接口,支持企业快速构建电商中台系统。其API体系具备模块化设计、双重认证机制、高并发支持和数据隔离等特性。文档详细解析了商品管理、订单处理、营销工具等核心接口功能,并提供实战代码示例。同时,介绍了企业级整合方案设计,如订单全链路自动化和商品数据中台架构,以及性能优化与稳定性保障措施。最后,针对高频问题提供了排查指南,帮助开发者高效利用API实现电商数智化转型。适合中高级开发者阅读。
Ollama本地模型部署+API接口调试超详细指南
本文介绍了如何使用Ollama工具下载并部署AI大模型(如DeepSeek-R1、Llama 3.2等)。首先,访问Ollama的官方GitHub页面下载适合系统的版本并安装。接着,在终端输入`ollama`命令验证安装是否成功。然后,通过命令如`ollama run Llama3.2`下载所需的AI模型。下载完成后,可以在控制台与AI模型进行对话,或通过快捷键`control+d`结束会话。为了更方便地与AI互动,可以安装GUI或Web界面。此外,Ollama还提供了API接口,默认支持API调用,用户可以通过Apifox等工具调试这些API。
云大使 X 函数计算 FC 专属活动上线!享返佣,一键打造 AI 应用
如今,AI 技术已经成为推动业务创新和增长的重要力量。但对于许多企业和开发者来说,如何高效、便捷地部署和管理 AI 应用仍然是一个挑战。阿里云函数计算 FC 以其免运维的特点,大大降低了 AI 应用部署的复杂性。用户无需担心底层资源的管理和运维问题,可以专注于应用的创新和开发,并且用户可以通过一键部署功能,迅速将 AI 大模型部署到云端,实现快速上线和迭代。函数计算目前推出了多种规格的云资源优惠套餐,用户可以根据实际需求灵活选择。
Serverless + AI 让应用开发更简单,加速应用智能化
Serverless + AI 让应用开发更简单,加速应用智能化
阿里云 EMR Serverless Spark 在微财机器学习场景下的应用
面对机器学习场景下的训练瓶颈,微财选择基于阿里云 EMR Serverless Spark 建立数据平台。通过 EMR Serverless Spark,微财突破了单机训练使用的数据规模瓶颈,大幅提升了训练效率,解决了存算分离架构下 Shuffle 稳定性和性能困扰,为智能风控等业务提供了强有力的技术支撑。
163 15
基于阿里云 EMR Serverless Spark 版快速搭建OSS日志分析应用
基于阿里云 EMR Serverless Spark 版快速搭建OSS日志分析应用

相关产品

  • 函数计算
  • AI助理

    你好,我是AI助理

    可以解答问题、推荐解决方案等