Déployer et tester une API

Cette page explique comment déployer votre API.

Avant de commencer

Déployer une API

Vous pouvez déployer votre API à l'aide des plug-ins App Engine Apache Maven ou Gradle. Pour déployer votre API dans un environnement standard App Engine de production, utilisez la commande correspondant à votre plug-in :

  1. Utilisez la commande correspondant à votre plug-in :

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Patientez jusqu'à la fin du déploiement.

  3. Envoyez une requête de test à l'API que vous venez de déployer. Par exemple, en utilisant curl :

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    Votre réponse ressemble à ce qui suit :

    {
  "message": "echo echo"
}

Si vous ne recevez pas de réponse positive, consultez la section Dépanner des erreurs de réponse.

Déployer sur 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.

Exécuter et tester des backends d'API en local

Pour tester votre API en local :

  1. Générez le projet dans son répertoire racine. Exemple :

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. Démarrez le serveur de développement App Engine. Exemple :

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. Créez une requête API pour tester votre API. Par exemple, via curl :

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

Diffuser votre API depuis un autre chemin d'accès

Pour diffuser votre API depuis un autre chemin d'accès, dans votre fichier web.xml, modifiez le paramètre url-pattern dans la section EndpointsServlet et redéployez votre API. Exemple :

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

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.