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

# sam local start-api
<a name="sam-cli-command-reference-sam-local-start-api"></a>

本页提供 AWS Serverless Application Model 命令行界面 (AWS SAMCLI) `sam local start-api` 子命令的参考信息。
+ 有关简介 AWS SAMCLI，请参阅 [那是什么 AWS SAMCLI？](what-is-sam-overview.md#what-is-sam-cli)
+ 有关使用 AWS SAMCLI`sam local start-api`子命令的文档，请参阅[使用 sam local start-api 进行测试简介](using-sam-cli-local-start-api.md)。

`sam local start-api`子命令在本地运行您的 AWS Lambda 函数，以便通过本地 HTTP 服务器主机进行测试。

## 用法
<a name="ref-sam-cli-local-start-api-usage"></a>

```
$ sam local start-api <options>
```

## 选项
<a name="ref-sam-cli-local-start-api-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-api-options-add-host"></a>
将主机名到 IP 地址的映射传递到 Docker 容器的主机文件。此参数可以传递多次。  

**Example**  
示例：`--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-api-options-beta-features"></a>
允许或拒绝测试版功能。

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
在配置文件中指定要使用的默认参数值的环境名称。默认值为“default”。有关配置文件的详细信息，请参阅 [AWS SAMCLI 配置文件](serverless-sam-cli-config.md)。

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
包含要使用的默认参数值的配置文件的路径和文件名。在项目目录的根目录中，默认值为“samconfig.toml”。有关配置文件的详细信息，请参阅 [AWS SAMCLI 配置文件](serverless-sam-cli-config.md)。

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
可选。在本地调试时，将环境变量传递到映像容器。

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
本地模拟的 Lambda 容器的主机。默认值为 `localhost`。如果要在 macOS 上的 Docker 容器中运行 AWS SAM CLI，可以指定 `host.docker.internal`。如果要在与之不同的主机上运行容器 AWS SAMCLI，则可以指定远程主机的 IP 地址。

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
应与容器端口绑定的主机网络接口的 IP 地址。默认值为 `127.0.0.1`。使用 `0.0.0.0` 可绑定到所有接口。

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
启用调试日志记录，以打印 AWS SAM CLI 生成的调试消息并显示时间戳。

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
要传递给调试程序的其他参数。

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
可选。指定在指定 `--warm-containers` 时应用调试选项的 Lambda 函数。此参数适用于 `--debug-port`、`--debugger-path` 和 `--debug-args`。

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
指定后，在调试模式下启动 Lambda 函数容器，并在本地主机上开放此端口。

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
将挂载到 Lambda 容器中的调试器的主机路径。

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
Lambda Docker 容器应连接到的现有 Docker 网络的名称或 ID，以及默认桥接网络。如果未指定此项，Lambda 容器将仅连接到默认的桥接 Docker 网络。

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
 AWS SAM 文件所在的基本目录的位置。如果 Docker 在远程计算机上运行，则必须在 Docker 计算机上挂载 AWS SAM 文件所在的路径，并修改此值以匹配远程计算机。

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
包含 Lambda 函数环境变量值的 JSON 或`.env`文件。文件格式会自动检测。

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
指定是否 AWS SAM CLI应重建用于调用带图层的函数的图像。

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
显示此消息并退出。

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
用于扩展 AWS SAM CLI 功能的钩子的名称。  
可接受的值：`terraform`。

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
要绑定的本地主机名或 IP 地址（默认值：'127.0.0.1'）。

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
要用于 Lambda 函数的容器映像的 URI。默认情况下，从 Amazon ECR Public 中 AWS SAM 提取容器镜像。使用此选项可从其他位置提取映像。  
您可以多次指定该选项。此选项的每个实例都可以采用字符串或键值对。如果指定字符串，则字符串就是要用于应用程序中所有函数的容器映像 URI。例如 `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`。如果指定键值对，则键是资源名称，值是要用于该资源的容器映像 URI。例如 `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `。如果使用键值对，您可以为不同的资源指定不同的容器映像。

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
指定模板使用的层下载到的基目录的位置。

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
运行时日志将被发送到的日志文件。

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
即使在 AWS SAM 模板中配置了内存，也可以在本地调用期间移除容器中的内存限制。

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
包含编码为键值对的 CloudFormation 参数覆盖的字符串。使用与 AWS Command Line Interface (AWS CLI) 相同的格式。 AWS SAMCLI 格式为显式密钥和值关键字，每个覆盖都用空格分隔。以下是两个示例：  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-api-options-port"></a>
要监听的本地端口号（默认值：'3000'）。

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
您的凭证文件中用于获取 AWS 凭证的特定个人资料。

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
要部署到的 AWS 区域。例如，us-east-1。

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
将您在命令行中提供的参数保存到 AWS SAM 配置文件中。

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
在调用完成后模拟关闭事件，以测试关闭行为的扩展处理。

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
如果没有进行任何基础架构更改，则跳过准备阶段。使用 `--hook-name` 选项。

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
指定 CLI 是否应跳过下拉最新 Docker 映像获取 Lambda 运行时的操作。

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
SSL 证书文件的路径（默认值：无）。使用此选项时，还必须使用 `--ssl-key-file` 选项。

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
SSL 密钥文件的路径（默认值：无）。使用此选项时，还必须使用 `--ssl-cert-file` 选项。

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
位于此目录中的任何静态资产（例如CSS/JavaScript/HTML）文件都显示在`/`。

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
 AWS SAM 模板文件。  
如果指定此选项，则仅 AWS SAM 加载模板及其指向的本地资源。

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
将 AWS SAM CLI 与 Terraform Cloud 配合使用时本地 Terraform 计划文件的相对路径或绝对路径。此选项要求将 `--hook-name` 设置为 `terraform`。

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
可选。指定 AWS SAM CLI 如何管理每个函数的容器。  
有两个选项：  
   `EAGER`：在启动时加载所有函数的容器，且在两次调用之间保持不变。  
   `LAZY`：仅在首次调用每个函数时加载容器。这些容器会持续存在，以便进行其他调用。

## 示例
<a name="sam-cli-command-reference-sam-local-start-api-examples"></a>

以下示例启动本地服务器，允许您通过 API 测试应用程序。要使此命令起作用，必须安装应用程序且 Docker 必须正在运行。

```
$ sam local start-api --port 3000
```