Implementar e testar uma API

Esta página descreve como implementar a sua API.

Antes de começar

Implementar uma API

Pode implementar a sua API através dos plug-ins Apache Maven ou Gradle do App Engine. Para implementar a sua API num ambiente padrão do App Engine de produção, use o comando para o seu plug-in:

  1. Use o comando para o seu plugin:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Aguarde até que a implementação esteja concluída.

  3. Envie um pedido de teste para a API implementada. Por exemplo, usar curl:

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    A sua resposta é semelhante à seguinte:

    {
  "message": "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 aplicação

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

Executar e testar back-ends de API localmente

Para testar a API localmente:

  1. Crie o projeto no diretório raiz do projeto. Por exemplo:

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. Inicie o servidor de programação do App Engine. Por exemplo:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. Faça um pedido de API para testar a sua API. Por exemplo, usar curl:

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

Publicar a sua API a partir de um caminho diferente

Para publicar a sua API a partir de um caminho diferente, no ficheiro web.xml, altere o url-pattern na secção EndpointsServlet e volte a implementar a API. Por exemplo:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

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.