Cette page explique comment déployer votre API.
Avant de commencer
- Configurez votre environnement de programmation et téléchargez les outils nécessaires.
- Créez l'API.
- Créez un serveur Web pour diffuser votre API.
Déployer votre API en production
Pour déployer une API, procédez comme suit :
Définissez la variable d'environnement
ENDPOINTS_GAE_SDK
sur le chemin d'accès de votre dossier SDK App Engine :Path_to_Cloud_SDK/platform/google_appengine
.Remplacez
Path_to_Cloud_SDK
par le résultat de la commande suivante :gcloud info --format="value(installation.sdk_root)"
Exécutez la commande suivante dans le répertoire principal de l'API :
gcloud app deploy
Attendez que le déploiement soit terminé et ignorez les messages d'avertissement. Un message semblable à celui-ci s'affiche alors :
File upload done. Updating service [default]...done.
Vérifiez que le déploiement a abouti en envoyant une requête de test à l'API, par exemple :
curl --request POST \ --header "Content-Type: application/json" \ --data '{"content":"echo"}' \ https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2
Remplacez
PROJECT_ID
par l'ID de votre projet etecho
par le nom de votre API.Voici les résultats :
{ "content": "echo echo" }
Si vous ne recevez pas de réponse positive, consultez la section Dépanner des erreurs de réponse.
Déployer vers plusieurs versions d'application
Pour en savoir plus sur la procédure de gestion des versions d'API et sur le déploiement vers différentes versions, consultez la page Gérer les versions d'une API.
Tester une API en local
Vous pouvez utiliser le serveur de développement local App Engine pour tester votre API localement. Pour en savoir plus sur le serveur de développement local, consultez la page Utiliser le serveur de développement local.
Pour exécuter votre API en local :
Depuis le répertoire racine du projet, démarrez le serveur de développement App Engine :
dev_appserver.py YOUR_PROJECT_DIR
Exécutez
curl
pour effectuer une requête d'API, par exemple :curl --request POST \ --header "Content-Type: application/json" \ --data '{"message":"echo"}' \ "${HOST}/_ah/api/echo/v1/echo?n=2"
Ajouter la gestion des API
Endpoints Frameworks fournit des fonctionnalités de gestion des API telles que :
Pour que votre API soit gérée par Endpoints Frameworks, vous devez générer et déployer un document OpenAPI décrivant votre API, comme indiqué dans la page Ajouter la gestion des API.