Créez et publiez une API utilisant EventBridge comme service backend dans API Gateway, puis appelez cette API en utilisant l'authentification par AppCode.
Présentation
Suivez les étapes ci-dessous dans l'ordre pour créer et publier une API dont le service backend est EventBridge :
Créer un service backend
Créer un groupe d'API
Créer une API
Créer une application et lui accorder les permissions nécessaires pour appeler l'API
Déboguer l'API
Appeler l'API
Prérequis
Le service EventBridge doit être activé et un bus d'événements personnalisé doit être créé. Pour plus d'informations, consultez la rubrique Gérer les bus d'événements personnalisés.
Étape 1 : Créer un service backend
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, sélectionnez Manage APIs > Backend Services.
Dans l'angle supérieur droit de la page, cliquez sur Create Backend Service. Dans la boîte de dialogue qui s'affiche, saisissez le nom du service backend, définissez le paramètre Type sur EventBridge, puis cliquez sur Confirm.
Sur la page Backend Services, repérez le service backend que vous venez de créer et sélectionnez Configure Backend Service and View Associated APIs dans la colonne Actions.
Cliquez sur l'onglet Production, puis sur Create dans l'angle supérieur droit de la section Basic Information afin de configurer le service backend pour l'environnement de production. La configuration du service backend dans l'environnement de production est obligatoire avant toute publication d'API dans cet environnement.
Sur la page Define Backend Service, sélectionnez le bus d'événements que vous avez créé dans la console EventBridge.
Si le bus d'événements sélectionné et votre instance API Gateway se trouvent dans la même région, API Gateway transfère un événement vers votre bus d'événements lorsque vous appelez une API via le réseau interne. Dans cet exemple, le bus d'événements et l'instance API Gateway résident tous deux dans la région Chine (Hangzhou). Une fois les paramètres configurés, cliquez sur Publish.
Étape 2 : Créer un groupe d'API
Les API sont gérées au sein de groupes d'API. Vous devez créer un groupe d'API avant de pouvoir créer une API.
Dans le volet de navigation de gauche de la console API Gateway, sélectionnez Manage APIs > API Groups. Dans l'angle supérieur droit de la page, cliquez sur Create Group. Dans la boîte de dialogue qui s'affiche, sélectionnez une instance, saisissez un nom de groupe et définissez un chemin de base. Le groupe d'API doit se trouver dans la same region que le bus d'événements utilisé.
Une fois le groupe d'API créé, il apparaît sur la page API Groups. Cliquez sur le nom du groupe pour accéder à la page Group Details, où vous pouvez associer un nom de domaine, modifier les informations de base et changer le type d'instance.
API Gateway attribue automatiquement un public second-level domain name au groupe d'API. Ce nom de domaine est réservé exclusivement au débogage et aux tests. Si vous utilisez ce nom de domaine pour effectuer des appels d'API, vous êtes limité à 100 appels par jour dans les régions situées hors de Chine continentale et à 1,000 appels par jour dans les régions de Chine continentale. Nous vous recommandons d'associer an independent domain name après avoir créé votre groupe d'API. Dans cet exemple, nous utilisons le nom de domaine de deuxième niveau par défaut.
Étape 3 : Créer une API
Dans le volet de navigation de gauche de la console API Gateway, sélectionnez Manage APIs-APIs. Dans l'angle supérieur droit de la page, cliquez sur Create API.
Configurez les informations de base de l'API.
Définissez les informations de base de l'API, notamment le groupe d'API, le nom, la méthode d'authentification, le type et la description. Dans cet exemple, le paramètre Group correspond au groupe d'API créé précédemment et le paramètre AppCode Authentication est défini sur Enable AppCode Authentication (Header & Query). Configurez les autres paramètres selon vos besoins, puis cliquez sur Next.
Configurez les informations de requête de l'API.
Spécifiez la manière dont un client (navigateur, application mobile ou système métier) envoie une requête à l'API. Indiquez le Request Type, le Protocol, le Request Path, la HTTP Method, le Request Mode ainsi que les paramètres de requête, puis cliquez sur Next. Dans cet exemple, le paramètre Request Mode est défini sur Pass-through. Cela signifie qu'API Gateway transmet les requêtes API directement à EventBridge sans les traiter.
Configurez les informations du service backend pour l'API.
Définissez le type de service backend, l'URL et le mappage des paramètres. Dans cet exemple, Use Existing Backend Service est sélectionné pour le Configuration Mode, EventBridge est choisi comme Backend Service Type, et le service backend créé précédemment est sélectionné dans la liste déroulante Backend Service. Cliquez sur Next.
Lors de la création d'une API utilisant EventBridge comme service backend, vous ne pouvez sélectionner qu'un service backend existant. La personnalisation du service backend n'est pas possible.
Définissez les réponses de l'API.
Configurez les informations de réponse afin de générer la documentation de l'API, qui aide les utilisateurs à comprendre son fonctionnement. Vous pouvez définir un exemple de réponse en cas de succès et un exemple de réponse en cas d'échec. Dans cet exemple, cette étape est ignorée. Cliquez sur Create.
Publiez l'API.
La configuration d'une API n'est effective qu'après sa publication dans un environnement. Dans cet exemple, le service backend étant configuré uniquement pour l'environnement de production, vous ne pouvez publier l'API que dans cet environnement. Pour publier l'API dans un autre environnement, configurez d'abord le service backend correspondant. Cliquez sur Publish dans le message confirmant la création réussie de l'API, puis suivez les instructions à l'écran pour publier l'API dans l'environnement de production.
Étape 4 : Créer une application et lui accorder les permissions pour appeler l'API
Une application sert d'identité pour appeler une API. Étant donné que le paramètre Security Authentication a été défini sur Alibaba Cloud App lors de la création de l'API, vous devez créer une application et l'autoriser à appeler l'API.
Créez une application.
Dans le volet de navigation de gauche de la console API Gateway, sélectionnez Call APIs-Apps pour créer une application. La méthode d'authentification Alibaba Cloud App prend en charge deux modes : une paire AppKey/AppSecret et un AppCode. Dans cet exemple, nous utilisons un AppCode. Pour plus d'informations, consultez la rubrique Autorisation d'API.
Accordez à l'application les permissions nécessaires pour appeler l'API.
Sur la page APIs, repérez l'API créée et cliquez sur Authorize dans la colonne Actions. Définissez le paramètre Stage sur l'environnement dans lequel vous avez publié l'API. Dans cet exemple, le paramètre Stage est défini sur Production. Saisissez le nom de l'application créée dans la zone de recherche de la section Choose Apps for Authorization. Dans les résultats de recherche, sélectionnez l'application créée, cliquez sur Add dans la colonne Actions, puis sur Confirm. Un message confirme que l'application est autorisée à appeler l'API.
Étape 5 : Déboguer l'API
API Gateway propose un outil de débogage en ligne. Utilisez cette fonctionnalité pour vérifier que l'API est correctement configurée avant de l'appeler depuis vos clients.
Sur la page APIs, cliquez sur le nom de l'API créée. Sur la page des détails de l'API, cliquez sur Debug API dans l'arborescence de navigation de gauche. Si vous avez défini des paramètres de requête, vous pouvez saisir différentes valeurs pour vérifier le bon fonctionnement de l'API.
Lors du débogage, assurez-vous que le paramètre App Name correspond à l'application autorisée et que l'environnement de débogage correspond à l'environnement dans lequel l'application est autorisée. À défaut, le débogage pourrait échouer. Dans cet exemple, Production est sélectionné.
Une fois le débogage réussi, vous pouvez consulter les détails de l'événement dans votre bus d'événements en vous basant sur l'ID d'événement renvoyé.
Étape 6 : Appeler l'API
Vous avez désormais créé et publié l'API, créé et autorisé l'application, et effectué le débogage de l'API. Vous pouvez appeler l'API depuis votre système métier en utilisant l'AppCode.
Pour plus d'informations sur l'appel de l'API, consultez la rubrique Appeler une API avec une authentification simple (AppCode).