Esta página descreve como estruturar e anotar seu código do Cloud Endpoints Frameworks. Para ver uma lista completa de todas as anotações compatíveis, consulte Anotações.
Antes de começar
- Configure o ambiente de desenvolvimento.
Clone o exemplo de estrutura do Endpoints Frameworks:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
O exemplo de estrutura do Endpoints Frameworks está localizado em:
cd appengine-java8/endpoints-v2-skeleton/
Para ajudar a explicar como as anotações funcionam, neste documento, usamos a amostra endpoints-v2-backend
para expor as anotações e outro código que você precisa incluir na amostra endpoints-v2-skeleton
para o desenvolvimento. No final, a amostra modificada endpoints-v2-skeleton
se comporta igual à amostra endpoints-v2-backend
que é usada nos Primeiros passos com o Endpoints Frameworks no App Engine.
Como criar e anotar código
Para anotar seu código:
-
Altere os diretórios para o diretório de origem Java do projeto, por exemplo:
src/main/java/com/example/skeleton
. -
Crie um arquivo de classe
JavaBean chamado
Message.java
que contenha o seguinte código: -
Edite o arquivo
MyApi.java
no exemplo de estrutura. Altere a anotação de definição@Api
com o seguinte:O atributo
version = "v1"
especifica a versão da API de amostra. O valor inserido se torna parte do caminho no URL para a API. Para mais informações sobre as versões, consulte Como gerenciar o controle de versões da API. -
Adicione o seguinte método
echo
como seu primeiro endpoint de API e o método auxiliardoEcho
ao seuMyApi.java
. -
Copie todas as importações de
Echo.java
e cole-as noMyApi.java
. -
Maven
Crie o projeto:
mvn clean package
Gradle
Crie o projeto:
gradle clean build
Noções básicas de anotações
Há três anotações comumente usadas em APIs de back-end:
@Api
contém os detalhes de configuração da API de back-end.@ApiMethod
marca um método de classe que faz parte da API de back-end. Os métodos não marcados com@ApiMethod
não são incluídos quando você gera bibliotecas de clientes e documentos de descoberta. A anotação@ApiMethod
também pode ser usada para substituir a configuração da API para um método específico.@Named
deve ser adicionado a todos os parâmetros transmitidos aos métodos do lado do servidor, a menos que o parâmetro seja um tipo de entidade.
Para ver uma lista completa de todas as anotações do Endpoints Frameworks, consulte Anotações e sintaxe.
A seguir
- Saiba como adicionar gerenciamento de APIs
- Saiba mais sobre tipos de parâmetro e retorno compatíveis
- Saiba mais sobre exceções e códigos de status