Nesta página, descrevemos como implantar sua API.
Antes de começar
Como implantar uma API
É possível implantar a API usando os plug-ins Apache Maven ou Gradle do App Engine. Para implantar sua API em um ambiente padrão de produção do App Engine, use o comando do seu plug-in:
- Use o comando do plug-in:
Maven
mvn appengine:deploy
Gradle
gradle appengineDeploy
- Aguarde a conclusão da implantação.
Envie uma solicitação de teste para a API implantada. Por exemplo, usando
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 resposta será semelhante a:
{ "message": "echo echo" }
Se não receber uma resposta bem-sucedida, consulte Como solucionar problemas em erros de resposta.
Como fazer a implantação em diversas versões de aplicativo
Para informações sobre como fazer o controle de versões da API e implantar em versões, consulte Processamento do controle de versões da API.
Como executar e testar back-ends de API localmente
Para testar a API localmente:
Crie o projeto no diretório raiz. Por exemplo:
Maven
mvn clean package
Gradle
gradle clean build
Inicie o servidor de desenvolvimento do App Engine. Por exemplo:
Maven
mvn appengine:run
Gradle
gradle appengineRun
Faça uma solicitação de API para testá-la. Por exemplo, usando
curl
:curl \ -H "Content-Type: application/json" \ -X POST \ -d '{"message": "echo"}' \ "${HOST}/_ah/api/echo/v1/echo?n=2"
Como exibir sua API de um caminho diferente
Para veicular a API a partir de um caminho diferente, no seu arquivo web.xml
, altere o url-pattern
na seção EndpointsServlet
e reimplante a API. Exemplo:
<servlet-mapping>
<servlet-name>EndpointsServlet</servlet-name>
<url-pattern>/example-api/*</url-pattern>
</servlet-mapping>
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.