As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Esta página fornece informações de referência para o AWS Serverless Application Model `sam local start-api` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam local start-api` subcomando, consulte[Introdução aos testes com sam local start-api](using-sam-cli-local-start-api.md).

O `sam local start-api` subcomando executa suas AWS Lambda funções localmente para testar por meio de um host de servidor HTTP local.

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

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

## Opções
<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>
Passa um nome de host para mapeamento de endereço IP para o arquivo host do contêiner do Docker. Esse parâmetro pode ser passado várias vezes.  

**Example**  
Exemplo: `--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>
Permita ou negue recursos beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
Opcional. Passe variáveis de ambiente para o contêiner de imagem ao depurar localmente.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
Host do contêiner Lambda emulado localmente. O valor padrão é `localhost`. Se você quiser executar AWS SAMCLI em um contêiner do Docker no macOS, você pode especificar `host.docker.internal`. Se você quiser executar o contêiner em um host diferente AWS SAMCLI, você pode especificar o endereço IP do host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
O endereço IP da interface de rede do host à qual as portas do contêiner devem se vincular. O valor padrão é `127.0.0.1`. Use `0.0.0.0` para vincular a todas as interfaces.

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
Argumentos adicionais a serem transmitidos para o depurador.

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
Opcional. Especifica a função do Lambda para aplicar opções de depuração quando for especificado como `--warm-containers`. Esse parâmetro se aplica a `--debug-port`, `--debugger-path` e `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
Quando especificado, inicia o contêiner da função do Lambda no modo de depuração e expõe essa porta no host local.

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
O caminho do host para um depurador que será montado no contêiner Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker do Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede de Docker de ponte padrão.

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
A localização do diretório base em que o AWS SAM arquivo existe. Se o Docker estiver sendo executado em uma máquina remota, você deverá montar o caminho em que o AWS SAM arquivo existe na máquina Docker e modificar esse valor para corresponder à máquina remota.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
O JSON ou `.env` arquivo que contém valores para as variáveis de ambiente da função Lambda. O formato do arquivo é detectado automaticamente.

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
Especifica se AWS SAM CLI deve reconstruir a imagem usada para invocar funções com camadas.

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
Mostra esta mensagem e sai.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
O nome do hook usado para estender a funcionalidade AWS SAMCLI.  
Valores aceitos: `terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
O nome do host local ou endereço IP ao qual se vincular (padrão: '127.0.0.1').

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
O URI da imagem de contêiner que você deseja usar para suas funções do Lambda. Por padrão, AWS SAM extrai a imagem do contêiner do Amazon ECR Public. Use essa opção para extrair a imagem de outro localização.  
Especifique essa opção várias vezes. Cada instância dessa opção pode ter uma string ou um par de valores-chave. Se você especificar uma string, ela será a URI da imagem do contêiner a ser usada para todas as funções em seu aplicativo. Por exemplo, `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`. Se você especificar um par de valores-chave, a chave será o nome do recurso e o valor será o URI da imagem do contêiner a ser usada para esse recurso. Por exemplo `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `. Com pares de valores-chave, você pode especificar imagens de contêiner diferentes para recursos diferentes.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
Especifica a localização com base na qual as camadas que seu modelo usa são baixadas.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
O arquivo de log para o qual enviar os registros de runtime.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
Remove a limitação de memória no contêiner durante a chamada local, mesmo quando a memória está configurada no AWS SAM modelo.

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e cada substituição é separada por um espaço. Veja dois exemplos a seguir:  
+ `--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>
O número da porta local para escutar (padrão: '3000').

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
Emula um evento de desligamento após a conclusão da invocação, a fim de testar o tratamento da extensão sobre o comportamento de desligamento.

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
Especifica se o comando deve ignorar a extração da imagem mais recente do Docker para o runtime do Lambda.

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
Caminho para o arquivo do certificado SSL (padrão: Nenhum). Ao usar essa opção, a opção `--ssl-key-file` também deve ser usada.

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Caminho para o arquivo de chave SSL (padrão: Nenhum). Ao usar essa opção, a opção `--ssl-cert-file` também deve ser usada.

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Todos os arquivos de ativos estáticos (por exemplo,CSS/JavaScript/HTML) localizados nesse diretório são apresentados em`/`.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
O arquivo AWS SAM de modelo.  
Se você especificar essa opção, AWS SAM carrega somente o modelo e os recursos locais para os quais ele aponta.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
O caminho relativo ou absoluto para seu arquivo de Terraform plano local ao usar o AWS SAMCLI com Terraform Cloud. Essa opção exige que `--hook-name` seja definida como `terraform`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
Opcional. Especifica como AWS SAMCLI gerencia os contêineres para cada função.  
Existem duas opções:  
   `EAGER`: os contêineres de todas as funções são carregados na inicialização e persistem entre as invocações.  
   `LAZY`: os contêineres são carregados somente quando cada função é invocada pela primeira vez. Esses contêineres persistem para invocações adicionais.

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

O exemplo a seguir inicia um servidor local, permitindo que você teste a aplicação por meio da API. Para que esse comando funcione, a aplicação deve estar instalada e o Docker deve estar em execução.

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