Création d'une définition d'API
Vous pouvez créer des définitions d'API en utilisant le API Designer ou l'interface de ligne de commande dans IBM® API Connect.
Avant de commencer
Une API est un ensemble de fonctions qui offre une fonctionnalité commerciale ou technique et qui peut être appelé par des applications à l'aide d'un protocole défini. Ces applications sont généralement des applications mobiles ou Web qui utilisent le protocole HTTP. Une définition d'API se compose de chemins et peut avoir l'un des types suivants :
- Définition d'API REST
Une API REST est un ensemble défini d'interactions qui utilise le protocole HTTP, généralement en utilisant JSON ou XML comme format des données qui sont échangées. Par exemple, une demande de données peut utiliser une méthode HTTP GET et un enregistrement de données peut utiliser une méthode HTTP POST. Le choix du format des données dépend du type d'application qui appelle l'API. JSON est généralement utilisé pour les pages web ou les applications mobiles qui présentent une interface utilisateur (en utilisant JavaScript ou HTML), tandis que XML est souvent utilisé pour les scénarios de machine à machine.
Vous pouvez exposer et sécuriser vos API existantes à l'aide d'un Proxy ou d'une stratégie Invoke .
Dans les deux cas, vous pouvez configurer votre définition d'API à l'aide du Concepteur d'APIou en écrivant un fichier de définition OpenAPI et en le publiant à l'aide du Concepteur d'API ou de l'interface de ligne de commande.
- API SOAP
Vous pouvez créer des définitions d'API SOAP basées sur un fichier WSDL (Web Services Description Language) existant. Vous pouvez utiliser cette fonction pour bénéficier des fonctionnalités fournies par, qui incluent l'analyse et le mappage entre les variables. Vous pouvez également exposer l'API à l'aide du portail de développeur pour tous les services SOAP existants dans votre organisation, y compris les services SOAP qui font partie d'une architecture orientée services (SOA) ou d'une infrastructure ESB (Enterprise Service Bus).
Vous pouvez créer des définitions d'API SOAP via l'interface de ligne de commande ou via API Designer.
A propos de cette tâche
Vous pouvez créer des définitions pour des API REST ou des API SOAP.
- Dans API Designer, vous pouvez ajouter une définition d'API REST en composant la définition d'API et ses opérations à partir de zéro ou en important un fichier de définition OpenAPI . Vous pouvez également utiliser les outils pour créer rapidement une API de proxy qui appelle un noeud final existant.
- Si vous disposez d'un service SOAP existant que vous souhaitez exposer plus largement, vous pouvez ajouter une API SOAP à IBM® API Connect. Vous pouvez utiliser le portail de développeur pour faire connaître le service SOAP aux développeurs. Si un développeur souhaite utiliser l'API SOAP, vous pouvez l'utiliser pour gérer son inscription et son accès au service, et suivre l'utilisation de cette API.