Esta página descreve as bibliotecas e as ferramentas, e fornece outras informações para ajudar a começar a usar os Endpoints Frameworks para Java. Consulte o artigo Acerca das estruturas de pontos finais para ver uma vista geral da arquitetura das estruturas de pontos finais.
Bibliotecas e ferramentas
Os frameworks do Cloud Endpoints para o ambiente padrão do App Engine oferecem as seguintes bibliotecas e ferramentas:
- O Endpoints Frameworks está disponível no
repositório Maven Central
no grupo
com.google.endpoints
. O ficheiro.jar
base necessário está no artefactoendpoints-framework
. Consulte o Javadoc da API para ver detalhes. - A ferramenta de linha de comandos
endpoints
(para Linux) ouendpoints.cmd
(para Windows) que pode usar para gerar pacotes de bibliotecas cliente e documentos de descoberta, que permitem que as apps Android e outros tipos de aplicações cliente acedam à sua API. - O plug-in do Maven dos Frameworks de Endpoints
e o
plug-in do Gradle dos Frameworks de Endpoints,
que usa para gerar o seguinte:
- Pacotes de bibliotecas cliente e documentos Discovery.
- Ficheiros de configuração OpenAPI, que usa se quiser funcionalidade de gestão de APIs como monitorização, registo e validação de chaves de API.
Requisitos
Para usar os Endpoints Frameworks, siga o processo apresentado no Tutorial.
Tem de saber como desenvolver o cliente da sua escolha, como clientes Web JavaScript ou clientes para dispositivos móveis, como Android.
Processo de desenvolvimento
O fluxo de trabalho geral para desenvolver uma aplicação com os Frameworks de Endpoints é o seguinte:
- Crie o seu projeto da API e, em seguida, escreva o código da API.
- Anotar a sua API para que as classes e as bibliotecas de cliente sejam geradas a partir dela.
- Gere o ficheiro de configuração da OpenAPI e implemente-o conforme descrito no Tutorial.
- Opcionalmente, teste a sua API localmente.
- Implemente a API.
- Gere a biblioteca de cliente.
- Escreva a sua aplicação cliente usando a biblioteca cliente quando fizer chamadas para a API.
Começar
Para começar, siga o tutorial para configurar, implementar e enviar pedidos para uma API de exemplo. Em seguida, volte a esta secção para ver as informações necessárias para configurar, implementar e testar a sua própria API.
Migrar da versão 1.0 dos Endpoints
Se já desenvolveu um back-end de API com a versão anterior dos Endpoints, siga o guia de migração para mover a sua app para a versão 2.0 dos Endpoints.