Nesta página, descrevemos as bibliotecas e ferramentas e fornecemos outras informações para ajudar você a usar o Endpoints Frameworks para Java. Consulte Sobre o Endpoints Frameworks para uma visão geral da arquitetura do Endpoints Frameworks.
Bibliotecas e ferramentas
O Cloud Endpoints Frameworks para o ambiente padrão do App Engine fornece as seguintes bibliotecas e ferramentas:
- O Endpoints Frameworks está disponível no Maven Central Repository (em inglês) no grupo
com.google.endpoints
. O arquivo.jar
exigido básico está no artefatoendpoints-framework
. Consulte o Javadoc da API para detalhes. - a ferramenta de linha de comando
endpoints
(para Linux) ouendpoints.cmd
(para Windows) que pode ser usada para gerar pacotes de biblioteca de cliente e documentos Discovery, que permitem que apps Android e outros tipos de aplicativos cliente acessem sua API. - O plug-in Maven do Endpoints Frameworks
e o
plug-in do Gradle para Endpoints Frameworks,
que você usa para gerar o seguinte:
- Pacotes de bibliotecas de cliente e documentos de descoberta.
- Arquivos de configuração da OpenAPI, que você usa se quiser ter funcionalidades de gerenciamento de APIs, como monitoramento, geração de registros e validação de chaves de API.
Requisitos
Para usar o Endpoints Frameworks, siga o processo mostrado no Tutorial.
É preciso saber como desenvolver um cliente escolhido por você, como clientes JavaScript da Web, ou clientes de dispositivos móveis, como Android.
Processo de desenvolvimento
O fluxo de trabalho geral para desenvolver um aplicativo usando o Endpoints Frameworks é:
- Crie seu projeto de API e escreva o código da API.
- Anote sua API para que classes e bibliotecas de cliente sejam geradas com base nela.
- Gere o arquivo de configuração OpenAPI e implante-o conforme descrito no tutorial.
- Como opção, teste sua API localmente.
- Implante a API.
- Gere a biblioteca de cliente.
- Grave seu aplicativo cliente usando a biblioteca de cliente ao fazer chamadas para a API.
Primeiros passos
Para começar, siga o Tutorial para configurar, implantar e enviar solicitações para uma API de amostra. Depois, volte a esta seção para ter informações sobre como configurar, implantar e testar sua própria API.
Como migrar do Endpoints versão 1.0
Se você já desenvolveu um back-end de API usando a versão anterior do Endpoints, siga o guia de migração para migrar o app para o Endpoints 2.0.