Como implantar e testar uma API

Nesta página, descrevemos como implantar sua API.

Antes de começar

Como implantar a API na produção

Para implantar uma API:

  1. Defina a variável de ambiente ENDPOINTS_GAE_SDK para o caminho da sua pasta do SDK do App Engine: Path_to_Cloud_SDK/platform/google_appengine.

    Substitua Path_to_Cloud_SDK pela saída do comando a seguir:

     gcloud info --format="value(installation.sdk_root)"

  2. Execute o seguinte comando no diretório principal da API:

     gcloud app deploy

    Aguarde a conclusão bem-sucedida da implantação, ignorando as mensagens de aviso. Quando a implantação for concluída, uma mensagem semelhante à seguinte será exibida:

    File upload done.
Updating service [default]...done.

  3. Confirme a implantação bem-sucedida enviando uma solicitação de teste para a API, por exemplo:

    curl --request POST \
   --header "Content-Type: application/json" \
   --data '{"content":"echo"}' \
   https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2

    Substitua PROJECT_ID pelo código do projeto e echo pelo nome da API.

    Os resultados são:

    {
 "content": "echo echo"
}

Se não receber uma resposta bem-sucedida, consulte Como solucionar problemas em erros de resposta.

Como implantar em diversas versões do app

Para informações sobre como fazer o controle de versões da API e implantar em versões, consulte Como processar o controle de versões da API.

Como testar uma API localmente

Use o servidor de desenvolvimento local do App Engine para testar sua API localmente. Para mais informações sobre o servidor de desenvolvimento local, consulte Como usar o servidor de desenvolvimento local.

Para executar a API localmente, siga estas etapas:

  1. No diretório raiz do projeto, inicie o servidor de desenvolvimento do App Engine:

    dev_appserver.py YOUR_PROJECT_DIR

  2. Execute curl para fazer uma solicitação de API, por exemplo:

     curl --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

Como adicionar gerenciamento de APIs

O Endpoints Frameworks oferece recursos de gerenciamento de API, como:

Para que sua API seja gerenciada pelo Cloud Endpoints, gere e implante um documento do OpenAPI que descreva sua API, conforme descrito em Como adicionar o gerenciamento de API.