Create an API and add an operation - API Gateway - Centre de documentation Alibaba Cloud

Cas d'utilisation

Vous pouvez créer des API au sein ou en dehors d'une instance, selon vos besoins.

Créer une API au sein d'une instance

Gestion dédiée des ressources : L'API gère uniquement les ressources ou la logique interne d'une instance spécifique.
Sécurité et isolation : Les données ou fonctionnalités nécessitent une isolation stricte et ne sont accessibles qu'à partir de l'instance.
Simplification de la configuration : Limiter la configuration à une instance donnée simplifie la gestion des API.

Créer une API en dehors d'une instance

Accès partagé entre instances : Plusieurs instances partagent une même définition d'API.
Gestion centralisée et supervision : Contrôle unifié des autorisations, journalisation et gestion du trafic.

Créer une API REST dans la console

Cloud-native API Gateway propose deux méthodes de création d'API via la console : au sein d'une instance ou en dehors d'une instance.

En dehors d'une instance

Connectez-vous à la console Cloud-native API Gateway.
Dans le volet de navigation de gauche, cliquez sur API. Dans la barre de menu supérieure, sélectionnez une région.
Cliquez sur Create API.

Sur la carte REST API, cliquez sur Create. Dans le panneau Create REST API, configurez les paramètres puis confirmez.

Paramètre	Description
API Name	Saisissez un nom pour l'API. Ce nom doit être unique à l'échelle globale.
Base path	Chemin de base de l'API. Lorsqu'un client appelle une opération spécifique, l'URL complète de la requête est `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Indique s'il faut activer la gestion des versions d'API. Les différentes versions d'une API sont indépendantes. Elles partagent le même nom mais peuvent présenter des informations de base et des opérations distinctes. Pour accéder à une version spécifique, incluez son identifiant de version dans la requête. Si vous activez Version Management, vous devez également configurer le paramètre Usage. Remarque Si vous définissez Usage sur Query, vous devez configurer le paramètre Add Query. Si vous définissez Usage sur Header, vous devez configurer le paramètre Add Header.
Usage	L'identifiant de version peut être transmis via le Path, un paramètre Query ou un en-tête Header. Path : Le chemin complet de la requête est `/{base path}/{version_number}/{operation_path}`. Query : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure le paramètre de requête spécifié dans Add Query, avec sa valeur définie sur le numéro de version. Header : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure l'en-tête spécifié dans Add Header, avec sa valeur définie sur le numéro de version.
Description	Saisissez une description pour l'API.
Resource Group	Sélectionnez le groupe de ressources cible. Pour en créer un nouveau, cliquez sur Create Resource Group à droite.

Cliquez sur Create API.

Sur la carte REST API, cliquez sur Create. Dans le panneau Create REST API, configurez les paramètres puis confirmez.

Paramètre	Description
API Name	Saisissez un nom pour l'API. Ce nom doit être unique à l'échelle globale.
Base path	Chemin de base de l'API. Lorsqu'un client appelle une opération spécifique, l'URL complète de la requête est `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Indique s'il faut activer la gestion des versions d'API. Les différentes versions d'une API sont indépendantes. Elles partagent le même nom mais peuvent présenter des informations de base et des opérations distinctes. Pour accéder à une version spécifique, incluez son identifiant de version dans la requête. Si vous activez Version Management, vous devez également configurer le paramètre Usage. Remarque Si vous définissez Usage sur Query, vous devez configurer le paramètre Add Query. Si vous définissez Usage sur Header, vous devez configurer le paramètre Add Header.
Usage	L'identifiant de version peut être transmis via le Path, un paramètre Query ou un en-tête Header. Path : Le chemin complet de la requête est `/{base path}/{version_number}/{operation_path}`. Query : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure le paramètre de requête spécifié dans Add Query, avec sa valeur définie sur le numéro de version. Header : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure l'en-tête spécifié dans Add Header, avec sa valeur définie sur le numéro de version.
Description	Saisissez une description pour l'API.
Resource Group	Sélectionnez le groupe de ressources cible. Pour en créer un nouveau, cliquez sur Create Resource Group à droite.

Au sein d'une instance

Connectez-vous à la console Cloud-native API Gateway.
Dans le volet de navigation de gauche, cliquez sur Instances. Dans la barre de menu supérieure, sélectionnez une région.
Sur la page Instances, cliquez sur l'Instance ID cible pour accéder à la page Overview. Dans le volet de navigation de gauche, cliquez sur API, puis sur Create API.

Sur la carte REST API, cliquez sur Create. Dans le panneau Create REST API, configurez les paramètres puis confirmez.

Paramètre	Description
API Name	Saisissez un nom pour l'API. Ce nom doit être unique à l'échelle globale.
Domain Name	Sélectionnez un ou plusieurs noms de domaine pour l'API. Pour créer un nouveau nom de domaine, cliquez sur Add Domain Name.
Base path	Chemin de base de l'API. Lorsqu'un client appelle une opération spécifique, l'URL complète de la requête est `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Indique s'il faut activer la gestion des versions d'API. Les différentes versions d'une API sont indépendantes. Elles partagent le même nom mais peuvent présenter des informations de base et des opérations distinctes. Pour accéder à une version spécifique, incluez son identifiant de version dans la requête. Si vous activez Version Management, vous devez également configurer le paramètre Usage. Remarque Si vous définissez Usage sur Query, vous devez configurer le paramètre Add Query. Si vous définissez Usage sur Header, vous devez configurer le paramètre Add Header.
Usage	L'identifiant de version peut être transmis via le Path, un paramètre Query ou un en-tête Header. Path : Le chemin complet de la requête est `/{base path}/{version_number}/{operation_path}`. Query : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure le paramètre de requête spécifié dans Add Query, avec sa valeur définie sur le numéro de version. Header : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure l'en-tête spécifié dans Add Header, avec sa valeur définie sur le numéro de version.
Description	Saisissez une description pour l'API.
Resource Group	Sélectionnez le groupe de ressources cible. Pour en créer un nouveau, cliquez sur Create Resource Group à droite.
Scenario	Sélectionnez le cas d'utilisation pour cette opération. Scénario de base : Single Service. Scénarios de déploiement canari : By Percentage (Multi-service), By Content (Multi-service) et By Tag (Proportion-based Routing). Remarque La somme des pourcentages de trafic pour tous les services cibles doit être égale à 100 %.
Backend Services	Associez un service backend depuis la passerelle actuelle ou le VPC. Si aucun service n'existe, cliquez sur Create Service pour en créer un. Important Lorsque vous créez un nouveau service, ses informations de port peuvent ne pas apparaître immédiatement. Développez la liste déroulante Service Name et cliquez sur Refresh. La synchronisation des informations se fait de manière asynchrone et peut prendre un certain temps.

Créer une API REST en important un fichier OpenAPI

Importez un fichier OpenAPI pour créer des API au sein ou en dehors d'une instance.

En dehors d'une instance

Connectez-vous à la console Cloud-native API Gateway.
Dans le volet de navigation de gauche, cliquez sur API. Dans la barre de menu supérieure, sélectionnez une région.
Cliquez sur Create API.

Sur la carte REST API, cliquez sur Import. Dans le panneau Create File based on OpenAPI, configurez les paramètres puis cliquez sur Precheck and Create.

Paramètre	Description
API Name	Saisissez un nom pour l'API. Ce nom doit être unique à l'échelle globale.
Upload method	Utilisez un Local File ou Import OSS files. Remarque Les fichiers importés localement ou depuis OSS doivent respecter la spécification OpenAPI.
OpenAPI File	Sélectionnez un fichier local ou collez son contenu texte. La taille du fichier ne doit pas dépasser 30 Mo.
Region selection	Sélectionnez la région où se trouvent vos ressources OSS.
OSS bucket	Sélectionnez un compartiment OSS. Les compartiments sans attribut de région ne sont pas pris en charge.
Version Management	Indique s'il faut activer la gestion des versions d'API. Les différentes versions d'une API sont indépendantes. Elles partagent le même nom mais peuvent présenter des informations de base et des opérations distinctes. Pour accéder à une version spécifique, incluez son identifiant de version dans la requête. Si vous activez Version Management, vous devez également configurer le paramètre Usage. Remarque Si vous définissez Usage sur Query, vous devez configurer le paramètre Add Query. Si vous définissez Usage sur Header, vous devez configurer le paramètre Add Header.
Usage	L'identifiant de version peut être transmis via le Path, un paramètre Query ou un en-tête Header. Path : Le chemin complet de la requête est `/{base path}/{version_number}/{operation_path}`. Query : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure le paramètre de requête spécifié dans Add Query, avec sa valeur définie sur le numéro de version. Header : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure l'en-tête spécifié dans Add Header, avec sa valeur définie sur le numéro de version.
Description	Saisissez une description pour l'API.
Resource Group	Sélectionnez le groupe de ressources cible. Pour en créer un nouveau, cliquez sur Create Resource Group à droite.

Au sein d'une instance

Connectez-vous à la console Cloud-native API Gateway.
Dans le volet de navigation de gauche, cliquez sur Instances. Dans la barre de menu supérieure, sélectionnez une région.
Sur la page Instances, cliquez sur l'Instance ID cible pour accéder à la page Overview. Dans le volet de navigation de gauche, cliquez sur API, puis sur Create API.

Sur la carte REST API, cliquez sur Import. Dans le panneau Create File based on OpenAPI, configurez les paramètres puis cliquez sur Precheck and Create.

Paramètre	Description
API Name	Saisissez un nom pour l'API. Ce nom doit être unique à l'échelle globale.
Domain Name	Sélectionnez un ou plusieurs noms de domaine pour l'API. Pour créer un nouveau nom de domaine, cliquez sur Add Domain Name.
Upload method	Utilisez un Local File ou Import OSS files. Remarque Les fichiers importés localement ou depuis OSS doivent respecter la spécification OpenAPI.
OpenAPI File	Sélectionnez un fichier local ou collez son contenu texte. La taille du fichier ne doit pas dépasser 30 Mo.
Region selection	Sélectionnez la région où se trouvent vos ressources OSS.
OSS bucket	Sélectionnez un compartiment OSS. Les compartiments sans attribut de région ne sont pas pris en charge.
Version Management	Indique s'il faut activer la gestion des versions d'API. Les différentes versions d'une API sont indépendantes. Elles partagent le même nom mais peuvent présenter des informations de base et des opérations distinctes. Pour accéder à une version spécifique, incluez son identifiant de version dans la requête. Si vous activez Version Management, vous devez également configurer le paramètre Usage. Remarque Si vous définissez Usage sur Query, vous devez configurer le paramètre Add Query. Si vous définissez Usage sur Header, vous devez configurer le paramètre Add Header.
Usage	L'identifiant de version peut être transmis via le Path, un paramètre Query ou un en-tête Header. Path : Le chemin complet de la requête est `/{base path}/{version_number}/{operation_path}`. Query : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure le paramètre de requête spécifié dans Add Query, avec sa valeur définie sur le numéro de version. Header : Le chemin complet de la requête est `/{base path}/{operation_path}`. La requête doit inclure l'en-tête spécifié dans Add Header, avec sa valeur définie sur le numéro de version.
Description	Saisissez une description pour l'API.
Resource Group	Sélectionnez le groupe de ressources cible. Pour en créer un nouveau, cliquez sur Create Resource Group à droite.
Scenario	Sélectionnez le cas d'utilisation pour cette opération. Scénario de base : Single Service. Scénarios de déploiement canari : By Percentage (Multi-service), By Content (Multi-service) et By Tag (Proportion-based Routing). Remarque La somme des pourcentages de trafic pour tous les services cibles doit être égale à 100 %.
Backend Services	Associez un service backend depuis la passerelle actuelle ou le VPC. Si aucun service n'existe, cliquez sur Create Service pour en créer un. Important Lorsque vous créez un nouveau service, ses informations de port peuvent ne pas apparaître immédiatement. Développez la liste déroulante Service Name et cliquez sur Refresh. La synchronisation des informations se fait de manière asynchrone et peut prendre un certain temps.

Ajouter une opération

Sur la page de détails de l'API REST, cliquez sur Add Operation.

Dans le panneau Add Operation, configurez les paramètres puis cliquez sur Add.

Paramètre	Description
Operation Name	Saisissez un nom pour l'opération. Ce nom doit être unique au sein de l'API.
Operation Path	Chemin de la requête pour cette opération.
Method	Méthode HTTP pour cette opération. La combinaison du chemin d'opération et de la méthode doit être unique au sein de l'API.
Description	Saisissez une description pour l'opération.
Request Definition	Définissez des paramètres Header, Query et path, ainsi qu'un corps Body. Les paramètres de chemin peuvent être définis dans le chemin de l'opération en utilisant l'un des trois formats suivants : /books/{bookId} /books/[bookId] /books/:bookId Nous vous recommandons d'utiliser le format `{bookId}`. Remarque Ces définitions servent uniquement à générer des SDK et de la documentation ; elles ne sont pas validées lors de l'exécution.
Response Definition	Définit la structure des données de réponse pour différents codes d'état. Ces définitions sont utilisées uniquement pour la génération de la documentation et ne sont pas validées lors de l'exécution.
Mock	Les configurations Mock prennent effet uniquement lorsque l'API est publiée dans un environnement Mock. Remarque Cette fonctionnalité est disponible uniquement pour les API créées en dehors d'une instance.
Consumer Authentication	Indique s'il faut activer l'authentification du consommateur. Désactivée par défaut. Si elle est activée, vous devez lier une autorisation de consommateur à cette opération pour qu'elle soit accessible.