Implementar e testar uma API

Esta página descreve como implementar a sua API.

Antes de começar

Implementar a sua API na produção

Para implementar uma API:

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

    Substitua Path_to_Cloud_SDK pela saída do seguinte comando:

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

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

     gcloud app deploy

    Aguarde alguns momentos até que a implementação seja bem-sucedida, ignorando as mensagens de aviso. Quando a implementação estiver concluída, é apresentada uma mensagem semelhante à seguinte:

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

  3. Confirme a implementação bem-sucedida enviando um pedido 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 ID do projeto e echo pelo nome da API.

    Os resultados são:

    {
 "content": "echo echo"
}

Se não recebeu uma resposta bem-sucedida, consulte o artigo Resolução de problemas de erros de resposta.

Implementação em várias versões da app

Para obter informações sobre como fazer o controlo de versões da API e como implementar versões, consulte o artigo Como lidar com o controlo de versões da API

Testar uma API localmente

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

Para executar a API localmente:

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

    dev_appserver.py YOUR_PROJECT_DIR

  2. Execute curl para fazer um pedido de API, por exemplo:

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

Adicionar gestão de APIs

Os Frameworks de Endpoints oferecem funcionalidades de gestão de APIs, como:

Para que a sua API seja gerida pelos Endpoints Frameworks, tem de gerar e implementar um documento OpenAPI que descreva a sua API, conforme descrito em Adicionar gestão de APIs.