Cloud Endpoints Frameworks

Cloud Endpoints Frameworks est un framework Web pour les environnements d'exécution Python 2.7 et Java 8 standards App Engine. Cloud Endpoints Frameworks fournit les outils et les bibliothèques requis pour vous permettre de générer des API REST et des bibliothèques clientes pour votre application.

À l'instar d'autres frameworks Web, Endpoints Frameworks est compatible avec les détails de communication de bas niveau des requêtes et réponses HTTP pour votre application. Lorsqu'un client envoie une requête à votre API, Endpoints Frameworks achemine l'URL de la requête vers la fonction ou la méthode de votre code qui traite la requête. Endpoints Frameworks convertit la valeur d'affichage en JSON et envoie la réponse. Ajoutez des métadonnées à votre code source (en utilisant des annotations en Java et des décorateurs en Python). Les métadonnées définissent la surface des API REST pour votre application.

Java

@ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}

Dans l'exemple de code, les annotations commencent par le caractère @.

Python

@endpoints.method(
    # This method takes a ResourceContainer defined above.
    ECHO_RESOURCE,
    # This method returns an Echo message.
    EchoResponse,
    path="echo",
    http_method="POST",
    name="echo",
)
def echo(self, request):
    output_message = " ".join([request.message] * request.n)
    return EchoResponse(message=output_message)

Dans l'exemple de code, les décorateurs commencent par le caractère @.

Avec Endpoints Frameworks, il n'est pas nécessaire de déployer de serveur Web tiers (tel qu'Apache Tomcat ou Gunicorn) avec votre application. Vous annotez ou décorez le code et déployez votre application comme vous le feriez normalement vers l'environnement standard App Engine.

Gestion des API

Le proxy Extensible Service Proxy (ESP) fournit des fonctionnalités de gestion des API pour Cloud Endpoints pour OpenAPI et Cloud Endpoints pour gRPC. ESP s'exécute dans un conteneur avec chaque instance de votre backend.

Étant donné que l'environnement standard App Engine n'acceptait pas les déploiements multiconteneurs lorsque Endpoints Frameworks était en cours de développement, ce dernier ne fait pas appel au proxy ESP. Endpoints Frameworks comprend ainsi une passerelle API intégrée qui fournit des fonctionnalités de gestion des API comparables à celles fournies par ESP pour Cloud Endpoints pour OpenAPI et Cloud Endpoints pour gRPC.

Endpoints Frameworks intercepte toutes les requêtes et effectue les vérifications nécessaires, telles que l'authentification, avant de transmettre ces requêtes au backend de l'API. Lorsque le backend répond, Endpoints Frameworks rassemble et consigne les données de télémétrie. Vous pouvez afficher les métriques de votre API sur la page Services Endpoints de la console Google Cloud .

Vous pouvez utiliser Endpoints Frameworks avec ou sans fonctionnalité de gestion des API. L'utilisation d'Endpoints Frameworks sans fonctionnalité de gestion d'API est offerte gratuitement. La fonctionnalité de gestion des API est facturée conformément à la page de tarification Endpoints.

Limites

  • Endpoints Frameworks est exclusivement pris en charge par les environnements d'exécution Python 2.7 et Java 8 standard App Engine.
  • Endpoints Frameworks ne prend pas en charge les environnements d'exécution Node.js, PHP et Go dans l'environnement standard App Engine.
  • Endpoints Frameworks ne prend pas en charge l'environnement flexible App Engine.
  • Endpoints Frameworks ne prend pas en charge les fonctions Cloud Run, Compute Engine et Google Kubernetes Engine.

Étapes suivantes