Vous pouvez créer et modifier des ébauches de définitions d'API REST à l'aide de l 'API Designer ou de l'interface utilisateur de l'API Designer sur IBM® API Connect.
A propos de cette tâche
Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.
Interface utilisateurAPI Manager uniquement: Pour effectuer cette tâche, vous devez disposer d'un rôle doté du droit Api-Drafts:Edit . Le rôle de développeur pré-fourni dispose de ce droit par défaut. Si un rôle personnalisé vous a été assigné,
celui-ci doit disposer de ce droit. Pour plus d'informations, voir Création de rôles personnalisés.
Procédure
Pour créer une définition REST OpenAPI, exécutez la procédure suivante.
- Dans le volet de navigation, cliquez
sur « Développement », puis sur ».L'écran Sélectionner le type d'API s'affiche.
- Sélectionnez OpenAPI 2.0 ou OpenAPI 3.0 en fonction de la version de la spécification OpenAPI sur laquelle votre API doit être basée.
- Sélectionnez Nouveau OpenAPI .
- Cliquez sur Suivant. Spécifiez le récapitulatif de l'API dans la section Infos. Vous pouvez affiner l'API après sa création.
- Le Titre peut contenir des caractères spéciaux mais doit rester court afin de pouvoir être facilement affiché dans l'interface utilisateur.
- Le Nom est entré automatiquement. La valeur de la zone Nom est une chaîne unique utilisée pour identifier l'API dans les commandes de l'interface de ligne de commande du kit d'outils de développement . Pour consulter les commandes CLI permettant de gérer les API en cours d'élaboration, consultez la documentation de référence de la CLI du kit d'outils.
- La Version correspond à la valeur de la propriété
info.version de la définition OpenAPI de l'API. Il est recommandé d'utiliser le schéma de numérotation de version
version.release.modification ; par exemple 1.0.0.
- Le Chemin de base est le segment d'URL de l'API et n'inclut pas le nom d'hôte ou des
segments supplémentaires pour les chemins ou les opérations. Le chemin de base ne peut pas contenir de caractères spéciaux et
doit commencer par un caractère
/
, même s'il est vide.
- La Description facultative permet d'identifier l'API.
- Cliquez sur Suivant. Dans la section Sécurisation, configurez la sécurité
d'API nécessaire.
- Sécuriser à l'aide de l'ID client - Sélectionnez cette option pour qu'une application fournisse
un ID client (clé d'API). Le paramètre
X-IBM-Client-Id est alors inclus dans l'en-tête de demande de l'API. Si cette option est sélectionnée, vous pouvez ensuite choisir de limiter les appels API par clé (par ID client) :
- Limiter les appels API par clé - Si cette option est sélectionnée, vous devez configurer la limite
de débit nécessaire. La limite de débit contrôle le nombre maximal d'appels autorisés pendant une période donnée (heure, minute, mois ou jour). Par exemple, 100 appels par heure.
- CORS - Sélectionnez cette option pour activer la prise en charge du partage de ressources d'origine croisée (CORS)
pour votre API. Votre API est alors accessible à partir d'un autre
domaine.
Remarque :
- CORS L'assistance est disponible uniquement sur le DataPower® API Gateway.
- Lorsque CORS est activé, la passerelle d'API exécute la stratégie de préflux
cors pour gérer toutes les demandes CORS envoyées à l'API.
- Lorsque CORS est activé et qu'une demande avant action est reçue, seules les actions d'API suivantes sont effectuées :
- La stratégie de préflux
cors configure les en-têtes de réponse appropriés.
- Les en-têtes de réponse sont définis.
- Lorsqu'une demande avant action est reçue, l'indicateur
request.attributes.isCORSPreflight est défini sur true.
- Pour toutes les demandes avant action, les stratégies de préflux
security et client-identification sont toujours ignorées, que CORS soit activé ou non.
- Cliquez sur Suivant pour créer votre définition d'API.
Le panneau Récapitulatif affiche des messages lors de la création de la définition, et les options de sécurité et limites de débit sélectionnées sont appliquées.
- Sélectionnez l'une des options suivantes :
- Pour configurer davantage votre API, cliquez sur Editer l'API. Pour plus de détails, voir Edition d'une définition d'API.
- Si vous ne souhaitez pas configurer davantage votre API pour l'instant, cliquez sur le lien
Développement dans le trajet de navigation pour revenir à la page d'accueil. Vous pouvez ensuite
passer immédiatement à une autre tâche. Pour plus de détails sur la configuration de votre API ultérieurement, voir Edition d'une définition d'API.
Résultats
Vous avez créé une définition d'API REST. Pour API Designer, les spécifications des API et des produits sont stockées dans le répertoire que vous avez spécifié lorsque vous vous êtes connecté. Pour API Manager, les spécifications des API et des produits sont stockées sur le serveur de gestion.
Etape suivante
Pour mettre les API à la disposition des développeurs d'applications, vous les incluez dans un produit que vous publiez dans un
catalogue. Pour plus d'informations, consultez les sections « Utilisation des produits » et « Utilisation des catalogues ».