sam本地start-api - AWS Serverless Application Model
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

sam本地start-api

允许您在本地运行无服务器应用程序,以便快速开发和测试。在包含无服务器功能和 AWS SAM 模板,它会创建托管所有功能的本地HTTP服务器。

访问它时(通过浏览器、CLI等),它会在本地启动Docker容器以调用功能。它读取 CodeUri 属性 AWS::Serverless::Function 资源,以在您的文件系统中查找包含 Lambda 功能代码。这可以是用于已解释语言(如Node.js和Python)的项目根目录,也可以是存储已编译工件或Java存档(JAR)文件的构建目录。

如果您正在使用解释的语言,则在每次调用时,本地更改立即在Docker容器中可用。对于需要复杂包装支持的更多编译语言或项目,我们建议您运行自己的建筑解决方案,并 AWS SAM 到包含构建工件的目录或文件。

要查看使用此命令的端到端示例,请参阅 教程: 部署HelloWorld应用程序. 的 sam local start-api 命令是的一部分 第4步: 在本地测试您的应用程序(可选).

用量:

sam local start-api [OPTIONS]

选项:

选项 Description
--host TEXT 要绑定的本地主机名或IP地址(默认值:'127.0.0.1')。
-p, --port INTEGER 要侦听的本地端口号(默认值:“3000”)。
-s, --static-dir TEXT 此目录下的任何静态资产(例如,CSS/JavaScript/HTML)文件均显示在/处。
-t, --template PATH 的 AWS SAM 模板文件[默认:模板。[yaml|yml]]。
-n, --env-vars PATH 包含Lambda函数环境变量值的JSON文件。
--parameter-overrides 可选。包含 AWS CloudFormation 参数覆盖编码为键值对。使用与 AWS CLI—例如,“参数键=键配对名称”, ParameterValue=我的键 ParameterKey=实例类型,参数值=t1.micro'。
-d, --debug-port TEXT 指定后,启动 Lambda 功能容器处于调试模式,并在本地主机上公开此端口。
--debugger-path TEXT 将安装到Lambda容器中的调试器的主机路径。
--debug-args TEXT 要传递给调试器的其他参数。
-v, --docker-volume-basedir TEXT 基本目录的位置,其中 AWS SAM 文件已存在。如果Docker在远程计算机上运行,您必须安装 AWS SAM 文件存在于Docker计算机上,并修改此值以匹配远程计算机。
--docker-network TEXT 现有Docker网络的名称或ID, Lambda Docker容器应与默认桥接网络一起连接。如果未指定, Lambda 容器仅连接到默认桥接Docker网络。
-l, --log-file TEXT 用于将运行时日志发送到的日志文件。
--layer-cache-basedir DIRECTORY 指定模板使用的图层下载至的位置依据。
--skip-pull-image 指定CLI是否应跳过为 Lambda 运行时。
--force-image-build 指定CLI是否应使用层重建用于调用函数的图像。
--profile TEXT 来自您的凭证文件的特定配置文件, AWS 凭证。
--region TEXT 的 AWS 要部署到的地区。例如,us-east-1。
--config-file PATH 包含要使用的默认参数值的配置文件的路径和文件名。默认值为项目目录的根目录下的"samconfig.toml"。有关配置文件的详细信息,请参阅 AWS SAM CLI配置文件
--config-env TEXT 在配置文件中指定默认参数值的环境名称,以使用。默认值为“默认”。有关配置文件的详细信息,请参阅 AWS SAM CLI配置文件
--debug 打开调试日志记录。
--help 显示此消息并退出。